StatusMessageFile Class

 

Represents a raw server status message.

Namespace:   Microsoft.ConfigurationManagement.Messaging.Messages.Server
Assembly:  Microsoft.ConfigurationManagement.Messaging (in Microsoft.ConfigurationManagement.Messaging.dll)

System::Object
  Microsoft.ConfigurationManagement.Messaging.Framework::MessageFileBase
    Microsoft.ConfigurationManagement.Messaging.Framework::VarFile
      Microsoft.ConfigurationManagement.Messaging.Messages.Server::StatusMessageFile

[SerializableAttribute]
public ref class StatusMessageFile sealed : VarFile

NameDescription
System_CAPS_pubmethodStatusMessageFile()

Initializes a new instance of the StatusMessageFile class.

NameDescription
System_CAPS_pubpropertyAttributeCount

Gets the attribute count.

System_CAPS_pubpropertyBuildNumber

Gets or sets the build number that the status message comes from. The default value is the build version of the binary. (Inherited from VarFile.)

System_CAPS_pubpropertyComponentName

Gets or sets the component name for the status message.

System_CAPS_pubpropertyFacility

Gets or sets the status message facility.

System_CAPS_pubpropertyFileSuffix

Gets the file suffix. (Overrides MessageFileBase::FileSuffix.)

System_CAPS_pubpropertyInsertStringCount

Gets the count of insert strings.

System_CAPS_pubpropertyIsSigned

If true, the file is signed. (Inherited from VarFile.)

System_CAPS_pubpropertyMachineName

Gets or sets the machine name. The default value is the current machine name.

System_CAPS_pubpropertyMessageId

Gets or sets the status message ID.

System_CAPS_pubpropertyMessageTime

Gets or sets the status message time. The default value is the current DateTime. This value must be greater than Epoch or the value will be overridden with the current DateTime.

System_CAPS_pubpropertyModuleName

Gets or sets the module name.

System_CAPS_pubpropertyParentSiteCode

Gets or sets the parent site for the current site. This value can be empty.

System_CAPS_pubpropertyProcessId

Gets or sets the process ID that is sending the state message. The default value is the current process ID.

System_CAPS_pubpropertySettings

Gets the properties and settings for the message. (Inherited from MessageFileBase.)

System_CAPS_pubpropertySeverity

Gets or sets the status message severity.

System_CAPS_pubpropertySigningCertificate

Gets or sets the certificate to use for signing. This property is ignored unless IsSigned is true. (Inherited from VarFile.)

System_CAPS_pubpropertySiteCode

Gets or sets the site code for the message.

System_CAPS_pubpropertyStatusType

Gets or sets the status message type.

System_CAPS_pubpropertyThreadId

Gets or sets the thread ID that is sending the state message. The default value is the current thread ID.

System_CAPS_pubpropertyTrusted

Gets or sets a value that indicates whether sending will use a trusted (authenticated) inbox. The default value is false. (Inherited from MessageFileBase.)

System_CAPS_pubpropertyWin32Error

Gets or sets the Win32 error. This value can be 0.

NameDescription
System_CAPS_pubmethodAddAttribute(UInt32, String^)

Adds an attribute to the status message.

System_CAPS_pubmethodAddInsertString(String^)

Adds an insert string.

System_CAPS_pubmethodDiscover()

Automatically discovers local information for sending a message. (Inherited from MessageFileBase.)

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_pubmethodGenerateFileName()

Generates a random name for the output file. (Inherited from MessageFileBase.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodSerialize()

Serializes to a VarFile byte stream. (Inherited from VarFile.)

System_CAPS_pubmethodSerializeToFile(String^)

Creates a file with a random file name and writes it to the output path. (Inherited from MessageFileBase.)

System_CAPS_pubmethodSerializeToInbox()

Creates a file and writes it directly to the appropriate inbox. If the Configuration Manager site server is not present on the local machine where this is run and HostName is not set, an exception will be raised. (Inherited from MessageFileBase.)

System_CAPS_pubmethodSerializeToInbox(String^)

Obsolete. Use SerializeToInbox and specify the server name by using HostName.

Creates a file and writes directly to the appropriate inbox. If the Configuration Manager site server is not present on the remote machine where this is run, an exception will be raised. (Inherited from MessageFileBase.)

System_CAPS_pubmethodToString()

Returns a String that represents the current Object. (Overrides Object::ToString().)

System_CAPS_pubmethodValidate()

Validates that all required properties are set for the message to be successfully sent. (Inherited from VarFile.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privpropertyIMessageBase::Settings

Gets the properties and settings for the message.(Inherited from MessageFileBase.)

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: