VarFile Class

Article
12/30/2016

Base class for a VarFile writer.

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.DataLoaderFile
Microsoft.ConfigurationManagement.Messaging.Messages.Server.StatusMessageFile

Syntax

[SerializableAttribute]
public abstract class VarFile : MessageFileBase

[SerializableAttribute]
public ref class VarFile abstract : MessageFileBase

<SerializableAttribute>
Public MustInherit Class VarFile
    Inherits MessageFileBase

Properties

	Name	Description
	BuildNumber	Gets or sets the build number that the status message comes from. The default value is the build version of the binary.
	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.
	IsSigned	If true, the file is signed.
	RecordId	Gets the message type ID for an implementing class.
	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.
	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 VarFile byte stream. (Overrides MessageFileBase.Serialize().)
	SerializeInlineMessage(Stream)	Adds inline data to the payload after initial serialization, if supported. (Inherited from MessageFileBase.)
	SerializeMessage(Stream)	Serializes the implementing message into the existing byte stream. (Inherited from MessageFileBase.)
	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. (Overrides MessageFileBase.Validate().)
	WriteByte(Stream, Byte)	Writes a byte to the stream.
	WriteHeaderRecord(Stream, Byte[], UInt32)	Writes a record to the file header.
	WriteHeaderRecord(Stream, Object, UInt32)	Writes a record to the file header.
	WriteHeaderRecord(Stream, String, UInt32)	Writes a record to the file header.
	WriteRecord(Stream, Byte[], UInt32)	Writes a single record to the VarFile.
	WriteRecord(Stream, String, UInt32)	Writes a single record to the VarFile.
	WriteStringValue(Stream, String)	Writes a string value into the stream and adds one byte for null termination.
	WriteStringValue(Stream, String, Boolean)	Writes a string of fixed length to the stream.
	WriteStringValue(Stream, String, Int32)	Writes a string value of a fixed length to the stream.
	WriteStringValue(Stream, String, Int32, Boolean)	Writes a string value of a fixed length to the stream.
	WriteStringValue(Stream, String, Int32, Boolean, Boolean)	Writes a string value of a fixed length to the stream.
	WriteValue<T>(Stream, T)	Writes a primitive value type into the stream. Do not use this method for a string.