DdmMessageFile<T> Class

Article
12/30/2016

Represents an generic Data Discovery Manager (DDM) 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.VarFile
Microsoft.ConfigurationManagement.Messaging.Framework.ConvertibleVarFile<T>
Microsoft.ConfigurationManagement.Messaging.Messages.Server.DdmMessageFile<T>
Microsoft.ConfigurationManagement.Messaging.Messages.Server.DiscoveryDataRecordFile
Microsoft.ConfigurationManagement.Messaging.Messages.Server.HeartbeatDiscoveryRecordFile
Microsoft.ConfigurationManagement.Messaging.Messages.Server.RegistrationDiscoveryRecordFile

Syntax

[SerializableAttribute]
public abstract class DdmMessageFile<T> : ConvertibleVarFile<T>
where T : IMessage

generic<typename T>
where T : IMessage
[SerializableAttribute]
public ref class DdmMessageFile abstract : ConvertibleVarFile<T>

<SerializableAttribute>
Public MustInherit Class DdmMessageFile(Of T As IMessage)
    Inherits ConvertibleVarFile(Of T)

Type Parameters

T
Message type for conversion.

Properties

	Name	Description
	AgentName	Gets the agent name.
	Architecture	Gets or sets the architecture for the DDM message.
	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.)
	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.)
	IsInline	If true, this is an inline VarFile. (Inherited from VarFile.)
	IsSigned	If true, the file is signed. (Inherited from VarFile.)
	RecordId	Gets the message type ID for an implementing class. (Overrides VarFile.RecordId.)
	Settings	Gets the properties and settings for the message. (Inherited from MessageFileBase.)
	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 DDM message.
	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
	AddDdmProperty(DdmProperty)	Adds a DDM property to the DDM file.
	ConvertMessage(T)	Converts an existing message to a VarFile representation. (Inherited from ConvertibleVarFile<T>.)
	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 VarFile byte stream. (Inherited from VarFile.)
	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 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()	(Inherited from Object.)
	Validate()	Validates that all required properties are set for the message to be successfully sent. (Inherited from VarFile.)