C# Class Microsoft.Protocols.TestSuites.MS_OXORULE.NspiRpcAdapter

The NspiRpcAdapter class contains the RPC implements for the interfaces of IMS_OXNSPIAdapter.

Inheritance: Microsoft.Protocols.TestTools.ManagedAdapterBase

Public Methods

Method	Description
NspiBind ( uint flags, STAT stat, FlatUID_r &serverGuid, bool needRetry = true ) : ErrorCodeValue	The NspiBind method initiates a session between a client and the server.
NspiQueryRows ( uint flags, STAT &stat, uint tableCount, uint table, uint count, PropertyTagArray_r propTags, PropertyRowSet_r &rows, bool needRetry = true ) : ErrorCodeValue	The NspiQueryRows method returns a number of rows from a specified table to the client.
NspiRpcAdapter ( ITestSite site, IntPtr rpcBinding, IntPtr contextHandle, int waitTime, uint maxRetryCount ) : System	Initializes a new instance of the NspiRpcAdapter class.
NspiUnbind ( uint reserved, IntPtr &contextHandle ) : uint	The NspiUnbind method destroys the context handle. No other action is taken.

Method	Description
Dispose ( bool disposing ) : void	This method is used to implement clean-up codes.

This method is used to implement clean-up codes.

protected Dispose ( bool disposing ) : void
disposing	bool	Set TRUE to dispose resource otherwise set FALSE.
return	void

The NspiBind method initiates a session between a client and the server.

public NspiBind ( uint flags, STAT stat, FlatUID_r &serverGuid, bool needRetry = true ) : ErrorCodeValue
flags	uint	A DWORD value that contains a set of bit flags.
stat	STAT	A pointer to a STAT block that describes a logical position in a specific address book container.
serverGuid	FlatUID_r	The value NULL or a pointer to a GUID value that is associated with the specific server.
needRetry	bool	A Boolean value indicates if need to retry to get an expected result. This parameter is designed to avoid meaningless retry when an error response is expected.
return	ErrorCodeValue

The NspiQueryRows method returns a number of rows from a specified table to the client.

public NspiQueryRows ( uint flags, STAT &stat, uint tableCount, uint table, uint count, PropertyTagArray_r propTags, PropertyRowSet_r &rows, bool needRetry = true ) : ErrorCodeValue
flags	uint	A DWORD value that contains a set of bit flags.
stat	STAT	A STAT block that describes a logical position in a specific address book container.
tableCount	uint	A DWORD value that contains the number values in the input parameter table. /// This value is limited to 100,000.
table	uint	An array of DWORD values, representing an Explicit Table.
count	uint	A DWORD value that contains the number of rows the client is requesting.
propTags	PropertyTagArray_r	The value NULL or a reference to a PropertyTagArray_r value, /// containing a list of the proptags of the properties that the client requires to be returned for each row returned.
rows	PropertyRowSet_r	A nullable PropertyRowSet_r value, it contains the address book container rows that the server returns in response to the request.
needRetry	bool	A bool value indicates if need to retry to get an expected result. This parameter is designed to avoid meaningless retry when an error response is expected.
return	ErrorCodeValue

Initializes a new instance of the NspiRpcAdapter class.

public NspiRpcAdapter ( ITestSite site, IntPtr rpcBinding, IntPtr contextHandle, int waitTime, uint maxRetryCount ) : System
site	ITestSite	The site instance.
rpcBinding	System.IntPtr	The RPC binding.
contextHandle	System.IntPtr	The RPC context handle.
waitTime	int	The time internal that is used to wait to retry when the returned error code is GeneralFailure.
maxRetryCount	uint	The retry count that is used to retry when the returned error code is GeneralFailure.
return	System

The NspiUnbind method destroys the context handle. No other action is taken.

public NspiUnbind ( uint reserved, IntPtr &contextHandle ) : uint
reserved	uint	A DWORD [MS-DTYP] value reserved for future use. This property is ignored by the server.
contextHandle	System.IntPtr	The RPC context handle.
return	uint