Share via


StateMessageFile Class

 

Represents an SMX state message file.

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.MessageFile<T>
      Microsoft.ConfigurationManagement.Messaging.Messages.Server.StateMessageFile

Syntax

[SerializableAttribute]
public sealed class StateMessageFile : MessageFile<ConfigMgrStateMessage>
[SerializableAttribute]
public ref class StateMessageFile sealed : MessageFile<ConfigMgrStateMessage^>
<SerializableAttribute>
Public NotInheritable Class StateMessageFile
    Inherits MessageFile(Of ConfigMgrStateMessage)

Constructors

Name Description
System_CAPS_pubmethod StateMessageFile(ConfigMgrStateMessage)

Initializes a new instance of the StateMessageFile class.

Properties

Name Description
System_CAPS_pubproperty FileSuffix

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

System_CAPS_pubproperty Priority

Gets or sets the priority to use for sending the message. This option is only used when SerializeToInbox is called.

System_CAPS_pubproperty Settings

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

System_CAPS_pubproperty SourceMessage

Gets the IMessage source for file serialization. (Inherited from MessageFile<T>.)

System_CAPS_pubproperty Trusted

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

Methods

Name Description
System_CAPS_pubmethod Discover()

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

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GenerateFileName()

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

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod Serialize()

Serializes to a byte stream. (Inherited from MessageFile<T>.)

System_CAPS_pubmethod Serialize(Boolean)

Serializes to a byte stream. (Inherited from MessageFile<T>.)

System_CAPS_pubmethod SerializeToFile(String)

Creates a file with a random file name and writes to the output path. (Inherited from MessageFile<T>.)

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

System_CAPS_pubmethod Validate()

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

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privproperty 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.

See Also

Microsoft.ConfigurationManagement.Messaging.Messages.Server Namespace

Return to top