CIM_LogRecord class

The LogRecord object can describe the definitional format for entries in a MessageLog, or can be used to instantiate the actual records in the Log. The latter approach provides a great deal more semantic definition and management control over the individual entries in a MessageLog, than do the record manipulation methods of the Log class. It is recommended that the data in individual Log entries be modeled using subclasses of LogRecord, to avoid the creation of LogRecords with one property (such as RecordData) without semantics.

Definitional formats for LogRecords could be specified by establishing a naming convention for the RecordID and Message Timestamp key properties.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Abstract, Version("2.8.1000"), UUID("{93e5f37b-7071-4c21-8733-d2eea2691e1a}"), AMENDMENT]
class CIM_LogRecord : CIM_ManagedElement
{
  string   Caption;
  string   Description;
  string   ElementName;
  string   LogCreationClassName;
  string   LogName;
  string   CreationClassName;
  string   RecordID;
  datetime MessageTimestamp;
  string   DataFormat;
  string   RecordFormat;
  string   RecordData;
};

Members

The CIM_LogRecord class has these types of members:

• Properties

Properties

The CIM_LogRecord class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short textual description of the object.

This property is inherited from CIM_ManagedElement.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

The name of the class used to create an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

DataFormat

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_LogRecord.RecordFormat")

A free-form string describing the log record's data structure.

Description

Data type: string

Access type: Read-only

A textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties/identity data, and description information.

This property is inherited from CIM_ManagedElement.

LogCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_MessageLog.CreationClassName"), MaxLen (256)

The CreationClassName of the scoping Log

LogName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_MessageLog.Name"), MaxLen (256)

The Name of the scoping Log

MessageTimestamp

Data type: datetime

Access type: Read-only

Qualifiers: Key

A datetime that, along with the RecordID property, serves to uniquely identify the log record within the log.

RecordData

Data type: string

Access type: Read-only

Qualifiers: Experimental, ModelCorrespondence ("CIM_LogRecord.RecordFormat")

A string containing log record data.

The RecordData string should be parsed according to the RecordFormat property. RecordData should begin with the defined delimiter and the delimiter should separate substrings in the manner described.

If the corresponding RecordFormat property is empty, or cannot be parsed, RecordData should be interpreted as a free-form string.

RecordFormat

Data type: string

Access type: Read-only

Qualifiers: Experimental, ModelCorrespondence ("CIM_LogRecord.RecordData")

Defines the data structure of the information in the RecordData property. If the RecordFormat string is empty, RecordData should be interpreted as a free-form string.

The RecordFormat string should be constructed as follows:

• The first character is a delimiter character. Use this character to split the rest of the string into sub-strings.

• Each delimited sub-string should be in the form of a CIM property declaration, that is <datatype> <property name>.

This set of declarations can be used to interpret the similarly delimited RecordData property.

For example, using a '*' delimiter, RecordFormat = "*string ThisDay*uint32 ThisYear*datetime SomeTime" may be used to interpret: RecordData = "*This is Friday*2002*20020807141000.000000-300".

RecordID

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

Along with the MessageTimestamp property, serves to uniquely identify the log record within the log.

Requirements

See also

CIM_ManagedElement