StatusMessageFile Class

Article
12/30/2016

Represents a raw server status message.

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

Inheritance Hierarchy

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

Syntax

[SerializableAttribute]
public sealed class StatusMessageFile : VarFile

[SerializableAttribute]
public ref class StatusMessageFile sealed : VarFile

<SerializableAttribute>
Public NotInheritable Class StatusMessageFile
    Inherits VarFile

Constructors

	Name	Description
	StatusMessageFile()	Initializes a new instance of the StatusMessageFile class.

Properties

	Name	Description
	AttributeCount	Gets the attribute count.
	BuildNumber	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.)
	ComponentName	Gets or sets the component name for the status message.
	Facility	Gets or sets the status message facility.
	FileSuffix	Gets the file suffix. (Overrides MessageFileBase.FileSuffix.)
	InsertStringCount	Gets the count of insert strings.
	IsSigned	If true, the file is signed. (Inherited from VarFile.)
	MachineName	Gets or sets the machine name. The default value is the current machine name.
	MessageId	Gets or sets the status message ID.
	MessageTime	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.
	ModuleName	Gets or sets the module name.
	ParentSiteCode	Gets or sets the parent site for the current site. This value can be empty.
	ProcessId	Gets or sets the process ID that is sending the state message. The default value is the current process ID.
	Settings	Gets the properties and settings for the message. (Inherited from MessageFileBase.)
	Severity	Gets or sets the status message severity.
	SigningCertificate	Gets or sets the certificate to use for signing. This property is ignored unless IsSigned is true. (Inherited from VarFile.)
	SiteCode	Gets or sets the site code for the message.
	StatusType	Gets or sets the status message type.
	ThreadId	Gets or sets the thread ID that is sending the state message. The default value is the current thread ID.
	Trusted	Gets or sets a value that indicates whether sending will use a trusted (authenticated) inbox. The default value is false. (Inherited from MessageFileBase.)
	Win32Error	Gets or sets the Win32 error. This value can be 0.

Methods

	Name	Description
	AddAttribute(UInt32, String)	Adds an attribute to the status message.
	AddInsertString(String)	Adds an insert string.
	Discover()	Automatically discovers local information for sending a message. (Inherited from MessageFileBase.)
	Equals(Object)	(Inherited from Object.)
	GenerateFileName()	Generates a random name for the output file. (Inherited from MessageFileBase.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	Serialize()	Serializes to a VarFile byte stream. (Inherited from VarFile.)
	SerializeToFile(String)	Creates a file with a random file name and writes it to the output path. (Inherited from MessageFileBase.)
	SerializeToInbox()	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.)
	SerializeToInbox(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.)
	ToString()	Returns a String that represents the current Object. (Overrides Object.ToString().)
	Validate()	Validates that all required properties are set for the message to be successfully sent. (Inherited from VarFile.)

Explicit Interface Implementations

	Name	Description
	IMessageBase.Settings	Gets the properties and settings for the message.(Inherited from MessageFileBase.)

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.