StatusMessageGenerator Class

Article
12/30/2016

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)

Inheritance Hierarchy

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

Syntax

[SerializableAttribute]
public sealed class StatusMessageGenerator : CcmEvent

[SerializableAttribute]
public ref class StatusMessageGenerator sealed : CcmEvent

<SerializableAttribute>
Public NotInheritable Class StatusMessageGenerator
    Inherits CcmEvent

Constructors

	Name	Description
	StatusMessageGenerator()	Initializes a new instance of the StatusMessageGenerator class. If you use this, you must invoke the GatherStatusMessageProperties method.
	StatusMessageGenerator(String)	Initializes a new instance of the StatusMessageGenerator class.

Properties

	Name	Description
	ClientId	Gets or sets the client ID of the client sending the status message. (Inherited from CcmEvent.)
	DateTime	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.)
	EventId	Gets or sets the NT event ID for the message. (Inherited from CcmEvent.)
	ProcessId	Gets or sets the ProcessID for the message. The default value is the ID for the current process. (Inherited from CcmEvent.)
	Severity	Gets the message severity. (Overrides CcmEvent.Severity.)
	StatusMessageProperties	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.
	StatusMessageQualifiers	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.
	StatusMessageType	Gets the status message type that is automatically parsed from the WMI event. (Overrides CcmEvent.StatusMessageType.)
	ThreadId	Gets or sets the ThreadID for the message. The default value is the thread ID for the current process. (Inherited from CcmEvent.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GatherStatusMessageProperties(String)	Attempts to pull all of the status message information from WMI.
	GetHashCode()	(Inherited from Object.)
	GetPropertyType(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.
	GetRequiredProperties()	Gets a list of all of the status message properties that must be set.
	GetType()	(Inherited from Object.)
	SetPropertyValue(String, Object)	Sets the value for a property.
	SetQualifierValue(String, Object)	Sets the value for a qualifier.
	ToString()	(Inherited from Object.)

Thread Safety

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

Share via