MessageFile<T> Class

Article
12/30/2016

Generic file writer for an IMessage type.

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.Messages.Server.StateMessageFile

Syntax

[SerializableAttribute]
public abstract class MessageFile<T> : MessageFileBase
where T : class, IMessage

generic<typename T>
where T : ref class, IMessage
[SerializableAttribute]
public ref class MessageFile abstract : MessageFileBase

<SerializableAttribute>
Public MustInherit Class MessageFile(Of T As { Class, IMessage })
    Inherits MessageFileBase

Type Parameters

T
IMessage type.

Constructors

	Name	Description
	MessageFile<T>(T)	Initializes a new instance of the MessageFile<T> class.

Properties

	Name	Description
	FileSuffix	Gets the file suffix. (Inherited from MessageFileBase.)
	InboxName	Gets the logical name for an inbox. If the inbox is not supported by the message, this method can return null. (Inherited from MessageFileBase.)
	Settings	Gets the properties and settings for the message. (Inherited from MessageFileBase.)
	SourceMessage	Gets the IMessage source for file serialization.
	SupportsInbox	Gets a value that indicates whether inbox writing is supported for the message. (Inherited from MessageFileBase.)
	Trusted	Gets or sets a value that indicates whether sending will use a trusted (authenticated) inbox. The default value is false. (Inherited from MessageFileBase.)
	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. (Inherited from MessageFileBase.)

Methods

	Name	Description
	Discover()	Automatically discovers local information for sending a message. (Inherited from MessageFileBase.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GenerateFileName()	Generates a random name for the output file. (Inherited from MessageFileBase.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	Serialize()	Serializes to a byte stream. (Overrides MessageFileBase.Serialize().)
	Serialize(Boolean)	Serializes to a byte stream.
	SerializeInlineMessage(Stream)	Adds inline data to the payload after initial serialization, if supported. (Inherited from MessageFileBase.)
	SerializeMessage(Stream)	Serializes the implementing message into the byte stream for VarFile serialization. (Overrides MessageFileBase.SerializeMessage(Stream).)
	SerializeToFile(String)	Creates a file with a random file name and writes to the output path. (Overrides MessageFileBase.SerializeToFile(String).)
	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()	(Inherited from Object.)
	Validate()	Validates that all required properties are set for the message to be sent successfully. (Inherited from MessageFileBase.)

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.

Share via