Share via


MessageFileBase Class

 

Base class used to write a message to a file.

Namespace:   Microsoft.ConfigurationManagement.Messaging.Framework
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.Framework.VarFile

Syntax

[SerializableAttribute]
public abstract class MessageFileBase : IMessageBase
[SerializableAttribute]
public ref class MessageFileBase abstract : IMessageBase
<SerializableAttribute>
Public MustInherit Class MessageFileBase
    Implements IMessageBase

Properties

Name Description
System_CAPS_pubproperty FileSuffix

Gets the file suffix.

System_CAPS_protproperty InboxName

Gets the logical name for an inbox. If the inbox is not supported by the message, this method can return null.

System_CAPS_pubproperty Settings

Gets the properties and settings for the message.

System_CAPS_protproperty SupportsInbox

Gets a value that indicates whether inbox writing is supported for the message.

System_CAPS_pubproperty Trusted

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

System_CAPS_protproperty TrustedInboxName

Gets the logical name for the trusted (authenticated) inbox. If the trusted inbox is not supported by the message, this method can return null.

Methods

Name Description
System_CAPS_pubmethod Discover()

Automatically discovers local information for sending a message.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GenerateFileName()

Generates a random name for the output file.

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod Serialize()

Serializes a message to a byte stream.

System_CAPS_protmethod SerializeInlineMessage(Stream)

Adds inline data to the payload after initial serialization, if supported.

System_CAPS_protmethod SerializeMessage(Stream)

Serializes the implementing message into the existing byte stream.

System_CAPS_pubmethod SerializeToFile(String)

Creates a file with a random file name and writes it to the output path.

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.

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.

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.

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privproperty IMessageBase.Settings

Gets the properties and settings for the message.

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.Framework Namespace

Return to top