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 | |
---|---|---|
FileSuffix | Gets the file suffix. |
|
InboxName | Gets the logical name for an inbox. If the inbox is not supported by the message, this method can return null. |
|
Settings | Gets the properties and settings for the message. |
|
SupportsInbox | Gets a value that indicates whether inbox writing is supported for the message. |
|
Trusted | Gets or sets a value that indicates whether sending will use a trusted (authenticated) inbox. The default value is false. |
|
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 | |
---|---|---|
Discover() | Automatically discovers local information for sending a message. |
|
Equals(Object) | (Inherited from Object.) |
|
Finalize() | (Inherited from Object.) |
|
GenerateFileName() | Generates a random name for the output file. |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
MemberwiseClone() | (Inherited from Object.) |
|
Serialize() | Serializes a message to a byte stream. |
|
SerializeInlineMessage(Stream) | Adds inline data to the payload after initial serialization, if supported. |
|
SerializeMessage(Stream) | Serializes the implementing message into the existing byte stream. |
|
SerializeToFile(String) | Creates a file with a random file name and writes it to the output path. |
|
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. |
|
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. |
|
ToString() | (Inherited from Object.) |
|
Validate() | Validates that all required properties are set for the message to be sent successfully. |
Explicit Interface Implementations
Name | Description | |
---|---|---|
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