C# Class Microsoft.Protocols.TestSuites.MS_OXCFXICS.FastTransferStream

Used for serializing or deserializing a fast transfer stream.

Inheritance: System.IO.MemoryStream

Show file Open project: OfficeDev/Interop-TestSuites Class Usage Examples

Public Properties

Property	Type	Description
GuidLength	int

Public Methods

Method	Description
BacktraceMarker ( ) : void	Backtracks the position with PidTagLength size.
BacktracePosition ( int count ) : void	Backtracks the position
FastTransferStream ( byte buffer, bool writable ) : System	Initializes a new instance of the FastTransferStream class.
ReadBlock ( int size ) : byte[]	Read bytes from stream, and advance the position.
ReadBlocks ( int totalSize, int blockSize ) : List	Read a list of blocks and advance the position.
ReadBoolean ( ) : ushort	Read a Boolean value from stream, and advance the position within the stream by 2
ReadCurrency ( ) : long	Read a currency value from stream, and advance the position within the stream by 8
ReadFloating32 ( ) : float	Read a float value from stream, and advance the position within the stream by 4
ReadFloating64 ( ) : double	Read a double value from stream, and advance the position within the stream by 8
ReadFloatingTime ( ) : double	Read a FloatingTime value from stream, and advance the position within the stream by 8
ReadGuid ( ) : System.Guid	Read a GUID value from stream, and advance the position.
ReadInt16 ( ) : short	Read a short value from stream, and advance the position within the stream by 2
ReadInt32 ( ) : int	Read an int value from stream, and advance the position within the stream by 4
ReadInt64 ( ) : long	Read a long value from stream, and advance the position within the stream by 8
ReadLengthBlock ( ) : byte[]>.Tuple	Read an int value and block and advance the position.
ReadLengthBlocks ( int totalLength ) : byte[]>>.List	Read a list of an int value and a block and advance the position.
ReadMarker ( ) : Markers	Read a Markers value from stream, and advance the position within the stream by 4
ReadMarker ( Markers desiredMarker ) : bool	Read a Markers from stream, compare it to the desired Marker.
ReadMetaProperty ( MetaProperties meta ) : bool	Read a MetaProperties value from stream, and advance the position within the stream by 4, compare it to the desired MetaProperties
ReadServerID ( ) : ServerID	Read a ServerID and advance the position.
ReadString ( ) : string	Read a string value from stream, and advance the position.
ReadString8 ( ) : string	Read a ASCII string value from stream, and advance the position.
ReadTime ( ) : ulong	Read a Time value from stream, and advance the position within the stream by 2
ReadUInt16 ( ) : ushort	Read a unsigned short integer value from stream, and advance the position within the stream by 2
ReadUInt32 ( ) : uint	Read a uint value from stream, and advance the position within the stream by 4
ReadUInt64 ( ) : ulong	Read the unsigned long integer value from stream, and advance the position within the stream by 8
ReadUInt8 ( ) : byte	Read a byte value from stream, and advance the position.
Verify ( byte val, int offset ) : bool	Indicate the byte value at the position plus an offset equals a specified byte
Verify ( uint val ) : bool	Indicate the uint value at the position equals a specified uint value.
Verify ( uint val, int offset ) : bool	Indicate the uint value at the position plus an offset equals a specified uint value.
Verify ( ushort val ) : bool	Indicate the unsigned short integer value at the position equals a specified unsigned short integer value.
VerifyErrorInfo ( int offset ) : bool	Indicate the MetaProperties at the position equals a specified PidTagFXErrorInfo
VerifyMarker ( ) : Markers	Get a Markers value from current position plus an offset and do not advance the position.
VerifyMarker ( int offset ) : Markers	Get a Markers value from current position plus an offset and do not advance the position.
VerifyMarker ( Markers marker ) : bool	Indicate the Markers at the position equals a specified Markers.
VerifyMarker ( Markers marker, int offset ) : bool	Indicate the Markers at the current position plus an offset equals a specified Markers
VerifyMetaProperty ( MetaProperties meta ) : bool	Indicate the MetaProperties at the position equals a specified MetaProperties
VerifyUInt16 ( ) : ushort	Get an unsigned short integer value for current position plus an offset and does not advance the position.
VerifyUInt16 ( int offset ) : ushort	Get an unsigned short integer value for current position plus an offset and do not advance the position.
VerifyUInt32 ( ) : uint	Get a uint value and do not advance the position.
VerifyUInt32 ( int offset ) : uint	Get a uint value for current position plus an offset and do not advance the position.

Method Details

BacktraceMarker() public method

Backtracks the position with PidTagLength size.

public BacktraceMarker ( ) : void
return	void

BacktracePosition() public method

Backtracks the position

public BacktracePosition ( int count ) : void
count	int	An int value
return	void

FastTransferStream() public method

Initializes a new instance of the FastTransferStream class.

public FastTransferStream ( byte buffer, bool writable ) : System
buffer	byte	A bytes array.
writable	bool	Whether the stream supports writing.
return	System

ReadBlock() public method

Read bytes from stream, and advance the position.

public ReadBlock ( int size ) : byte[]
size	int	The size of bytes
return	byte[]

ReadBlocks() public method

Read a list of blocks and advance the position.

public ReadBlocks ( int totalSize, int blockSize ) : List
totalSize	int	The total number of bytes to read
blockSize	int	The size of each block
return	List

ReadBoolean() public method

Read a Boolean value from stream, and advance the position within the stream by 2

public ReadBoolean ( ) : ushort
return	ushort

ReadCurrency() public method

Read a currency value from stream, and advance the position within the stream by 8

public ReadCurrency ( ) : long
return	long

ReadFloating32() public method

Read a float value from stream, and advance the position within the stream by 4

public ReadFloating32 ( ) : float
return	float

ReadFloating64() public method

Read a double value from stream, and advance the position within the stream by 8

public ReadFloating64 ( ) : double
return	double

ReadFloatingTime() public method

Read a FloatingTime value from stream, and advance the position within the stream by 8

public ReadFloatingTime ( ) : double
return	double

ReadGuid() public method

Read a GUID value from stream, and advance the position.

public ReadGuid ( ) : System.Guid
return	System.Guid

ReadInt16() public method

Read a short value from stream, and advance the position within the stream by 2

public ReadInt16 ( ) : short
return	short

ReadInt32() public method

Read an int value from stream, and advance the position within the stream by 4

public ReadInt32 ( ) : int
return	int

ReadInt64() public method

Read a long value from stream, and advance the position within the stream by 8

public ReadInt64 ( ) : long
return	long

ReadLengthBlock() public method

Read an int value and block and advance the position.

public ReadLengthBlock ( ) : byte[]>.Tuple
return	byte[]>.Tuple

ReadLengthBlocks() public method

Read a list of an int value and a block and advance the position.

public ReadLengthBlocks ( int totalLength ) : byte[]>>.List
totalLength	int	The number of bytes to read
return	byte[]>>.List

ReadMarker() public method

Read a Markers value from stream, and advance the position within the stream by 4

public ReadMarker ( ) : Markers
return	Markers

ReadMarker() public method

Read a Markers from stream, compare it to the desired Marker.

public ReadMarker ( Markers desiredMarker ) : bool
desiredMarker	Markers	The desired Markers.
return	bool

ReadMetaProperty() public method

Read a MetaProperties value from stream, and advance the position within the stream by 4, compare it to the desired MetaProperties

public ReadMetaProperty ( MetaProperties meta ) : bool
meta	MetaProperties	The desired Markers
return	bool

ReadServerID() public method

Read a ServerID and advance the position.

public ReadServerID ( ) : ServerID
return	ServerID

ReadString() public method

Read a string value from stream, and advance the position.

public ReadString ( ) : string
return	string

ReadString8() public method

Read a ASCII string value from stream, and advance the position.

public ReadString8 ( ) : string
return	string

ReadTime() public method

Read a Time value from stream, and advance the position within the stream by 2

public ReadTime ( ) : ulong
return	ulong

ReadUInt16() public method

Read a unsigned short integer value from stream, and advance the position within the stream by 2

public ReadUInt16 ( ) : ushort
return	ushort

ReadUInt32() public method

Read a uint value from stream, and advance the position within the stream by 4

public ReadUInt32 ( ) : uint
return	uint

ReadUInt64() public method

Read the unsigned long integer value from stream, and advance the position within the stream by 8

public ReadUInt64 ( ) : ulong
return	ulong

ReadUInt8() public method

Read a byte value from stream, and advance the position.

public ReadUInt8 ( ) : byte
return	byte

Verify() public method

Indicate the byte value at the position plus an offset equals a specified byte

public Verify ( byte val, int offset ) : bool
val	byte	A uint value
offset	int	An int value
return	bool

Verify() public method

Indicate the uint value at the position equals a specified uint value.

public Verify ( uint val ) : bool
val	uint	A uint value.
return	bool

Verify() public method

Indicate the uint value at the position plus an offset equals a specified uint value.

public Verify ( uint val, int offset ) : bool
val	uint	A uint value
offset	int	An int value
return	bool

Verify() public method

Indicate the unsigned short integer value at the position equals a specified unsigned short integer value.

public Verify ( ushort val ) : bool
val	ushort	An unsigned short integer value
return	bool

VerifyErrorInfo() public method

Indicate the MetaProperties at the position equals a specified PidTagFXErrorInfo

public VerifyErrorInfo ( int offset ) : bool
offset	int	An int value
return	bool

VerifyMarker() public method

Get a Markers value from current position plus an offset and do not advance the position.

public VerifyMarker ( ) : Markers
return	Markers

VerifyMarker() public method

Get a Markers value from current position plus an offset and do not advance the position.

public VerifyMarker ( int offset ) : Markers
offset	int	An int value
return	Markers

VerifyMarker() public method

Indicate the Markers at the position equals a specified Markers.

public VerifyMarker ( Markers marker ) : bool
marker	Markers	A Markers value
return	bool

VerifyMarker() public method

Indicate the Markers at the current position plus an offset equals a specified Markers

public VerifyMarker ( Markers marker, int offset ) : bool
marker	Markers	A Markers to be verified
offset	int	An int value
return	bool

VerifyMetaProperty() public method

Indicate the MetaProperties at the position equals a specified MetaProperties

public VerifyMetaProperty ( MetaProperties meta ) : bool
meta	MetaProperties	A MetaProperties value
return	bool

VerifyUInt16() public method

Get an unsigned short integer value for current position plus an offset and does not advance the position.

public VerifyUInt16 ( ) : ushort
return	ushort

VerifyUInt16() public method

Get an unsigned short integer value for current position plus an offset and do not advance the position.

public VerifyUInt16 ( int offset ) : ushort
offset	int	An int value
return	ushort

VerifyUInt32() public method

Get a uint value and do not advance the position.

public VerifyUInt32 ( ) : uint
return	uint

VerifyUInt32() public method

Get a uint value for current position plus an offset and do not advance the position.

public VerifyUInt32 ( int offset ) : uint
offset	int	An int value
return	uint

Property Details

GuidLength public static property

The length of a GUID structure.

public static int GuidLength
return	int