Class CIM_Message

CIM_Message instances represent DMTF standard messages that contain identification of the message, dynamic message arguments and the expanded message text. They can be used for returning detailed information from methods.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_Message

Direct Known Subclasses

CIM_Error

Class Qualifiers

NameData TypeValue
DescriptionstringCIM_Message instances represent DMTF standard messages that contain identification of the message, dynamic message arguments and the expanded message text. They can be used for returning detailed information from methods.
Exceptionbooleantrue
Experimentalbooleantrue
Indicationbooleantrue
ModelCorrespondencestringCIM_Error
UMLPackagePathstringCIM::Interop
Versionstring2.30.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
ContinuedInNextMessageboolean
DescriptionstringAn indicator that allows combining multiple messages into one logical message. The messages being combined need to be consecutive messages in an ordered sequence of messages (e.g. an indexed array of embedded instances of CIM_Message). A value of True indicates that the logical message continues with the next message after this message. A value of False or Null indicates that the logical message ends at this message. For instances of CIM_Message that are not part of an ordered sequence of messages, this property is meaningless and shall be Null.
Messagestring
DescriptionstringThe message text, with all dynamic elements expanded. The property value shall constructed by combining all static and dynamic message elements defined in the message definition in the order defined, using the values specified in the MessageArguments array property for the dynamic elements, in the order of the array.
ModelCorrespondencestringCIM_Message.MessageArguments
Requiredbooleantrue
MessageIDstring
DescriptionstringAn opaque string that uniquely identifies, within the scope of the OwningEntity, the format of the Message.
ModelCorrespondencestringCIM_Message.OwningEntity
Requiredbooleantrue
OwningEntitystring
DescriptionstringA string that uniquely identifies the entity that owns the definition of the message. OwningEntity shall include a copyrighted, trademarked or otherwise unique name that is owned by the business entity or standards body defining the message.
ModelCorrespondencestringCIM_Message.MessageID
Requiredbooleantrue
MessageArgumentsstring[]
ArrayTypestringIndexed
DescriptionstringAn array containing the values of the dynamic elements of the message, in the order in which the dynamic elements are defined in the message definition.
ModelCorrespondencestringCIM_Message.Message

Class Methods