StatusMessageGenerator Class

 

This class generates a status message and validates it. This is more structured than AdhocStatusMessage because it performs validations against actual status messages.

This class polls WMI. Therefore, there must be an SMS client or management point installed or this class will not work.

Namespace:   Microsoft.ConfigurationManagement.Messaging.StatusMessages
Assembly:  Microsoft.ConfigurationManagement.Messaging (in Microsoft.ConfigurationManagement.Messaging.dll)

System::Object
  Microsoft.ConfigurationManagement.Messaging.StatusMessages::CcmEvent
    Microsoft.ConfigurationManagement.Messaging.StatusMessages::StatusMessageGenerator

[SerializableAttribute]
public ref class StatusMessageGenerator sealed : CcmEvent

NameDescription
System_CAPS_pubmethodStatusMessageGenerator()

Initializes a new instance of the StatusMessageGenerator class. If you use this, you must invoke the GatherStatusMessageProperties method.

System_CAPS_pubmethodStatusMessageGenerator(String^)

Initializes a new instance of the StatusMessageGenerator class.

NameDescription
System_CAPS_pubpropertyClientId

Gets or sets the client ID of the client sending the status message. (Inherited from CcmEvent.)

System_CAPS_pubpropertyDateTime

Gets or sets the time for the status message. The default value is Now.

This value needs to be set to a SmsTime-style format, not a DateTime format, or serialization on the management point will fail. (Inherited from CcmEvent.)

System_CAPS_pubpropertyEventId

Gets or sets the NT event ID for the message. (Inherited from CcmEvent.)

System_CAPS_pubpropertyProcessId

Gets or sets the ProcessID for the message. The default value is the ID for the current process. (Inherited from CcmEvent.)

System_CAPS_pubpropertySeverity

Gets the message severity. (Overrides CcmEvent::Severity.)

System_CAPS_pubpropertyStatusMessageProperties

Performs consistency checks on the status message properties. This property should not be invoked directly. Only call this property by using ConfigMgrStatusMessage.ParseStatusMessage(...).

An exception is thrown if any required properties are not set.

System_CAPS_pubpropertyStatusMessageQualifiers

Performs consistency checks on the status message qualifiers. This property should not be invoked directly. Only call this property by using SccmStatusMessage.ParseStatusMessage(...).

An exception is thrown if any required qualifiers are not set.

System_CAPS_pubpropertyStatusMessageType

Gets the status message type that is automatically parsed from the WMI event. (Overrides CcmEvent::StatusMessageType.)

System_CAPS_pubpropertyThreadId

Gets or sets the ThreadID for the message. The default value is the thread ID for the current process. (Inherited from CcmEvent.)

NameDescription
System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_pubmethodGatherStatusMessageProperties(String^)

Attempts to pull all of the status message information from WMI.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetPropertyType(String^)

Gets the CimType for a property. When this class sends a status message to the management point, it always sends the message as an object without any validation. The user of this class must verify type correctness.

System_CAPS_pubmethodGetRequiredProperties()

Gets a list of all of the status message properties that must be set.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodSetPropertyValue(String^, Object^)

Sets the value for a property.

System_CAPS_pubmethodSetQualifierValue(String^, Object^)

Sets the value for a qualifier.

System_CAPS_pubmethodToString()

(Inherited from Object.)

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: