C# Class Microsoft.Protocols.TestSuites.MS_OXCRPC.AdapterHelper

The class provides methods to assist MS-OXCRPCAdapter.

Show file Open project: OfficeDev/Interop-TestSuites

Public Properties

Property	Type	Description
RPCHeaderExtlength	int

Public Methods

Method	Description
ComposeRgbAuxIn ( RgbAuxInEnum rgbAuxIn, byte rgbAuxInPayload ) : byte[]	Composes rgbAuxIn buffer
ComposeRgbIn ( ROPCommandType ropType, uint inputServerObjectHandle, TaggedPropertyValue propertyValue ) : byte[]	A method used to compose ROP command to execute ROP call.
ComposeRgbIn ( ROPCommandType ropType, uint inputServerObjectHandle, ulong auxInfo ) : byte[]	A method used to compose ROP command to execute ROP call.
Compose_AUX_CLIENT_CONNECTION_INFO ( int reserved, int connectionFlags ) : byte[]	Compose buffer for AUX_CLIENT_CONNECTION_INFO
Compose_AUX_PERF_ACCOUNTINFO ( int reserved ) : byte[]	Compose buffer for AUX_PERF_ACCOUNTINFO, refer to the definition of AUX_PERF_ACCOUNTINFO
Compose_AUX_PERF_CLIENTINFO ( int reserved, short clientMode ) : byte[]	Composes buffer for AUX_PERF_CLIENTINFO, refer to the definition of AUX_PERF_CLIENTINFO in this Open Specification
Compose_AUX_PERF_DEFGC_SUCCESS ( int reserved ) : byte[]	Composes buffer for AUX_PERF_DEFGC_SUCCESS, refer to the definition of AUX_PERF_DEFGC_SUCCESS in this Open Specification
Compose_AUX_PERF_DEFMDB_SUCCESS ( int reserved ) : byte[]	Composes buffer for AUX_PERF_DEFMDB_SUCCESS, refer to the definition of AUX_PERF_DEFMDB_SUCCESS in this Open Specification
Compose_AUX_PERF_FAILURE ( int reserved ) : byte[]	Composes buffer for AUX_PERF_FAILURE, refer to the definition of AUX_PERF_FAILURE in this Open Specification
Compose_AUX_PERF_FAILURE_V2 ( int reserved1, int reserved2 ) : byte[]	Composes buffer for AUX_PERF_FAILURE_V2, refer to definition of AUX_PERF_FAILURE_V2 in this Open Specification
Compose_AUX_PERF_GC_SUCCESS ( int reserved1, int reserved2 ) : byte[]	Composes buffer for AUX_PERF_GC_SUCCESS, refer to the definition of AUX_PERF_GC_SUCCESS in this Open Specification
Compose_AUX_PERF_GC_SUCCESS_V2 ( int reserved ) : byte[]	Composes buffer for AUX_PERF_GC_SUCCESS_V2, refer to the definition of AUX_PERF_GC_SUCCESS_V2 in this Open Specification
Compose_AUX_PERF_MDB_SUCCESS_V2 ( int reserved ) : byte[]	Composes buffer for AUX_PERF_MDB_SUCCESS_V2, refer to the definition of AUX_PERF_MDB_SUCCESS_V2 in this Open Specification
Compose_AUX_PERF_PROCESSINFO ( int reserved1, int reserved2 ) : byte[]	Composes buffer for AUX_PERF_PROCESSINFO, refer to the definition of AUX_PERF_PROCESSINFO in this Open Specification
Compose_AUX_PERF_SESSIONINFO ( int reserved ) : byte[]	Composes buffer for AUX_PERF_SESSIONINFO, refer to the definition of AUX_PERF_SESSIONINFO in this Open Specification
Compose_AUX_PERF_SESSIONINFO_V2 ( int reserved ) : byte[]	Composes buffer for AUX_PERF_SESSIONINFO_V2, refer to the definition of AUX_PERF_SESSIONINFO_V2 in this Open Specification
ConvertVersion ( ushort version, ushort &normalizeVersion ) : void	Convert the three DWORD version into a normalized version.
Initialize ( ITestSite testSite ) : void	Initialize the AdapterHelper class.

Method Details

ComposeRgbAuxIn() public static method

Composes rgbAuxIn buffer

public static ComposeRgbAuxIn ( RgbAuxInEnum rgbAuxIn, byte rgbAuxInPayload ) : byte[]
rgbAuxIn	RgbAuxInEnum	Enum value of rgbAuxIn
rgbAuxInPayload	byte	The payload of rgbAuxIn buffer.
return	byte[]

ComposeRgbIn() public static method

A method used to compose ROP command to execute ROP call.

public static ComposeRgbIn ( ROPCommandType ropType, uint inputServerObjectHandle, TaggedPropertyValue propertyValue ) : byte[]
ropType	ROPCommandType	A parameter represents the ROP Type refers to a specific ROP call.
inputServerObjectHandle	uint	A parameter represents an input Server object handle.
propertyValue	Microsoft.Protocols.TestSuites.Common.TaggedPropertyValue	A parameter represents a TaggedPropertyValue structure.
return	byte[]

ComposeRgbIn() public static method

A method used to compose ROP command to execute ROP call.

public static ComposeRgbIn ( ROPCommandType ropType, uint inputServerObjectHandle, ulong auxInfo ) : byte[]
ropType	ROPCommandType	A parameter represents the ROP Type refers to a specific ROP call.
inputServerObjectHandle	uint	A parameter represents an input Server object handle.
auxInfo	ulong	The auxInfo point to the object executed by this ROP call. /// It could be a folder handle, a message handle or an attachment handle or the count to be operated.
return	byte[]

Compose_AUX_CLIENT_CONNECTION_INFO() public static method

Compose buffer for AUX_CLIENT_CONNECTION_INFO

public static Compose_AUX_CLIENT_CONNECTION_INFO ( int reserved, int connectionFlags ) : byte[]
reserved	int	Value for Reserved field in AUX_CLIENT_CONNECTION_INFO
connectionFlags	int	The value of ConnectionFlags
return	byte[]

Compose_AUX_PERF_ACCOUNTINFO() public static method

Compose buffer for AUX_PERF_ACCOUNTINFO, refer to the definition of AUX_PERF_ACCOUNTINFO

public static Compose_AUX_PERF_ACCOUNTINFO ( int reserved ) : byte[]
reserved	int	Value for Reserved field in AUX_PERF_ACCOUNTINFO
return	byte[]

Compose_AUX_PERF_CLIENTINFO() public static method

Composes buffer for AUX_PERF_CLIENTINFO, refer to the definition of AUX_PERF_CLIENTINFO in this Open Specification

public static Compose_AUX_PERF_CLIENTINFO ( int reserved, short clientMode ) : byte[]
reserved	int	Value for Reserved field in AUX_PERF_CLIENTINFO
clientMode	short	The value of ClientMode that determines the mode in which the client is running
return	byte[]

Compose_AUX_PERF_DEFGC_SUCCESS() public static method

Composes buffer for AUX_PERF_DEFGC_SUCCESS, refer to the definition of AUX_PERF_DEFGC_SUCCESS in this Open Specification

public static Compose_AUX_PERF_DEFGC_SUCCESS ( int reserved ) : byte[]
reserved	int	Value for Reserved field in AUX_PERF_DEFGC_SUCCESS
return	byte[]

Compose_AUX_PERF_DEFMDB_SUCCESS() public static method

Composes buffer for AUX_PERF_DEFMDB_SUCCESS, refer to the definition of AUX_PERF_DEFMDB_SUCCESS in this Open Specification

public static Compose_AUX_PERF_DEFMDB_SUCCESS ( int reserved ) : byte[]
reserved	int	Value for Reserved field in AUX_PERF_DEFMDB_SUCCESS
return	byte[]

Compose_AUX_PERF_FAILURE() public static method

Composes buffer for AUX_PERF_FAILURE, refer to the definition of AUX_PERF_FAILURE in this Open Specification

public static Compose_AUX_PERF_FAILURE ( int reserved ) : byte[]
reserved	int	Value for Reserved field in AUX_PERF_FAILURE
return	byte[]

Compose_AUX_PERF_FAILURE_V2() public static method

Composes buffer for AUX_PERF_FAILURE_V2, refer to definition of AUX_PERF_FAILURE_V2 in this Open Specification

public static Compose_AUX_PERF_FAILURE_V2 ( int reserved1, int reserved2 ) : byte[]
reserved1	int	Value for Reserved_1 field in AUX_PERF_FAILURE_V2
reserved2	int	Value for Reserved_2 field in AUX_PERF_FAILURE_V2
return	byte[]

Compose_AUX_PERF_GC_SUCCESS() public static method

Composes buffer for AUX_PERF_GC_SUCCESS, refer to the definition of AUX_PERF_GC_SUCCESS in this Open Specification

public static Compose_AUX_PERF_GC_SUCCESS ( int reserved1, int reserved2 ) : byte[]
reserved1	int	Value for Reserved_1 field in AUX_PERF_GC_SUCCESS
reserved2	int	Value for Reserved_2 field in AUX_PERF_GC_SUCCESS
return	byte[]

Compose_AUX_PERF_GC_SUCCESS_V2() public static method

Composes buffer for AUX_PERF_GC_SUCCESS_V2, refer to the definition of AUX_PERF_GC_SUCCESS_V2 in this Open Specification

public static Compose_AUX_PERF_GC_SUCCESS_V2 ( int reserved ) : byte[]
reserved	int	Value for Reserved field in AUX_PERF_GC_SUCCESS_V2
return	byte[]

Compose_AUX_PERF_MDB_SUCCESS_V2() public static method

Composes buffer for AUX_PERF_MDB_SUCCESS_V2, refer to the definition of AUX_PERF_MDB_SUCCESS_V2 in this Open Specification

public static Compose_AUX_PERF_MDB_SUCCESS_V2 ( int reserved ) : byte[]
reserved	int	Value for Reserved field in AUX_PERF_MDB_SUCCESS_V2
return	byte[]

Compose_AUX_PERF_PROCESSINFO() public static method

Composes buffer for AUX_PERF_PROCESSINFO, refer to the definition of AUX_PERF_PROCESSINFO in this Open Specification

public static Compose_AUX_PERF_PROCESSINFO ( int reserved1, int reserved2 ) : byte[]
reserved1	int	Value for Reserved_1 field in AUX_PERF_PROCESSINFO
reserved2	int	Value for Reserved_2 field in AUX_PERF_PROCESSINFO
return	byte[]

Compose_AUX_PERF_SESSIONINFO() public static method

Composes buffer for AUX_PERF_SESSIONINFO, refer to the definition of AUX_PERF_SESSIONINFO in this Open Specification

public static Compose_AUX_PERF_SESSIONINFO ( int reserved ) : byte[]
reserved	int	Value for Reserved field in AUX_PERF_SESSIONINFO
return	byte[]

Compose_AUX_PERF_SESSIONINFO_V2() public static method

Composes buffer for AUX_PERF_SESSIONINFO_V2, refer to the definition of AUX_PERF_SESSIONINFO_V2 in this Open Specification

public static Compose_AUX_PERF_SESSIONINFO_V2 ( int reserved ) : byte[]
reserved	int	Value for Reserved field in AUX_PERF_SESSIONINFO_V2
return	byte[]

ConvertVersion() public static method

Convert the three DWORD version into a normalized version.

public static ConvertVersion ( ushort version, ushort &normalizeVersion ) : void
version	ushort	The three DWORD version.
normalizeVersion	ushort	The returned normalized version.
return	void

Initialize() public static method

Initialize the AdapterHelper class.

public static Initialize ( ITestSite testSite ) : void
testSite	ITestSite	The instance of ITestSite.
return	void

Property Details

RPCHeaderExtlength public static property

An integer indicates the length of RPC_HEADER_EXT.

public static int RPCHeaderExtlength
return	int