SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

## Class CIM_RecordForLog

Used in features: CIM Schema inheritance classes

    CIM_ManagedElement
       CIM_RecordForLog

Known Subclasses:
  CIM_LogEntry AMT_SetupAuditRecord

    Abstract class CIM_RecordForLog

extends CIM_ManagedElement

General Information:
The RecordForLog class is used to instantiate records to be aggregated to a Log.
Qualifiers:
-------------
Abstract
Version=2.9.0
UMLPackagePath=CIM::System::Logs

Supported Fields Summary
`string` | `ElementName` A user-friendly name for the object . . .
`string` | `Description` The Description property provides a textual description of the object.
`string` | `Caption` The Caption property is a short textual description (one- line string) of the object.
`string` | `InstanceID` InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace . . .
`string` | `RecordFormat` A string describing the data structure of the information in the property, RecordData . . .
`string` | `RecordData` A string containing LogRecord data . . .
`string` | `Locale` A locale indicates a particular geographical, political, or cultural region . . .

Methods Summary

Field Detail

### ElementName

    public string ElementName

  General Information:
  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.
  Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties.
  Qualifiers:
  -------------
  MaxLen=256

### Description

    public string Description

  General Information:
  The Description property provides a textual description of the object.
  Qualifiers:
  -------------
  MaxLen=256

### Caption

    public string Caption

  General Information:
  The Caption property is a short textual description (one- line string) of the object.
  Qualifiers:
  -------------
  MaxLen=64

### InstanceID

    public string InstanceID

  General Information:
  InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.
  To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:
  <OrgID>:<LocalID>
  Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.
  <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.
  If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.
  Qualifiers:
  -------------
  MaxLen=256

### RecordFormat

    public string RecordFormat

  General Information:
  A string describing the data structure of the information in the property, RecordData. If the RecordFormat string is <empty>, RecordData should be interpreted as a free-form string.
  To describe the data structure of RecordData, the RecordFormat string should be constructed as follows:
  - The first character is a delimiter character and is used to parse the remainder of the string into sub-strings.
  - Each sub-string is separated by the delimiter character and should be in the form of a CIM property declaration (i.e., datatype and property name). This set of declarations may 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".
  Qualifiers:
  -------------
  ModelCorrespondence={CIM_RecordForLog.RecordData}
  MaxLen=256

### RecordData

    public string RecordData

  General Information:
  A string containing LogRecord data.
  If the corresponding RecordFormat property is <empty>, or cannot be parsed according to the recommended format, RecordData should be interpreted as a free-form string. If the RecordFormat property contains parseable format information (as recommended in the RecordFormat Description qualifier), the RecordData string SHOULD be parsed in accordance with this format. In this case, RecordData SHOULD begin with the delimiter character and this character SHOULD be used to separate substrings in the manner described. The RecordData string can then be parsed by the data consumer and appropriately typed.
  Qualifiers:
  -------------
  ModelCorrespondence={CIM_RecordForLog.RecordFormat}
  MaxLen=256

### Locale

    public string Locale

  General Information:
  A locale indicates a particular geographical, political, or cultural region. The Locale specifies the language used in creating the RecordForLog data. If the Locale property is empty, it is assumed that the default locale is en_US (English).
  The locale string consists of three sub-strings, separated by underscores:
  - The first sub-string is the language code, as specified in ISO639.
  - The second sub-string is the country code, as specified in ISO3166.
  - The third sub-string is a variant, which is vendor specific.
  For example, US English appears as: "en_US_WIN", where the "WIN" variant would specify a Windows browser-specific collation (if one exists). Since the variant is not standardized, it is not commonly used and generally is limited to easily recognizable values ("WIN", "UNIX", "EURO", etc.) used in standard environments. The language and country codes are required; the variant may be empty.
  Qualifiers:
  -------------
  MaxLen=256

Method Detail

SUMMARY: NESTED | FIELD | METHOD
DETAIL: FIELD | METHOD