Share via


ConvertibleVarFile<T> Class

 

Represents a VarFile type that can be converted from an existing 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.VarFile
      Microsoft.ConfigurationManagement.Messaging.Framework.ConvertibleVarFile<T>
        Microsoft.ConfigurationManagement.Messaging.Messages.Server.DdmMessageFile<T>

Syntax

[SerializableAttribute]
public abstract class ConvertibleVarFile<T> : VarFile
where T : IMessage
generic<typename T>
where T : IMessage
[SerializableAttribute]
public ref class ConvertibleVarFile abstract : VarFile
<SerializableAttribute>
Public MustInherit Class ConvertibleVarFile(Of T As IMessage)
    Inherits VarFile

Type Parameters

  • T
    Message type.

Properties

Name Description
System_CAPS_pubproperty 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.)

System_CAPS_pubproperty FileSuffix

Gets the file suffix. (Inherited from MessageFileBase.)

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. (Inherited from MessageFileBase.)

System_CAPS_protproperty IsInline

If true, this is an inline VarFile. (Inherited from VarFile.)

System_CAPS_pubproperty IsSigned

If true, the file is signed. (Inherited from VarFile.)

System_CAPS_protproperty RecordId

Gets the message type ID for an implementing class. (Inherited from VarFile.)

System_CAPS_pubproperty Settings

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

System_CAPS_pubproperty SigningCertificate

Gets or sets the certificate to use for signing. This property is ignored unless IsSigned is true. (Inherited from VarFile.)

System_CAPS_protproperty SupportsInbox

Gets a value that indicates whether inbox writing is supported for the message. (Inherited from MessageFileBase.)

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

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. (Inherited from MessageFileBase.)

Methods

Name Description
System_CAPS_pubmethod ConvertMessage(T)

Converts an existing message to a VarFile representation.

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_protmethod Finalize()

(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_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod Serialize()

Serializes to a VarFile byte stream. (Inherited from VarFile.)

System_CAPS_protmethod SerializeInlineMessage(Stream)

Adds inline data to the payload after initial serialization, if supported. (Inherited from MessageFileBase.)

System_CAPS_protmethod SerializeMessage(Stream)

Serializes the implementing message into the existing byte stream. (Inherited from MessageFileBase.)

System_CAPS_pubmethod SerializeToFile(String)

Creates a file with a random file name and writes it to the output path. (Inherited from MessageFileBase.)

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 successfully sent. (Inherited from VarFile.)

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

Return to top