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

The MapiHttpAdapter class contains the MAPIHTTP implements for the interfaces of IMS_OXNSPIAdapter.

Public Methods

Method	Description
Bind ( uint flags, STAT stat, FlatUID_r &serverGuid ) : ErrorCodeValue	The NspiBind method initiates a session between a client and the server.
NspiMapiHttpAdapter ( ITestSite site, string userName, string password, string domainName, string addressBookUrl ) : System	Initializes a new instance of the NspiMapiHttpAdapter class.
QueryRows ( uint flags, STAT &stat, uint tableCount, uint table, uint count, PropertyTagArray_r propTags, PropertyRowSet_r &rows ) : ErrorCodeValue	The NspiQueryRows method returns a number of rows from a specified table to the client.
Unbind ( uint reserved ) : uint	The NspiUnbind method destroys the context handle. No other action is taken.

Method	Description
BuildBindRequestBody ( STAT stat, uint flags ) : BindRequestBody	Initialize Bind request body.
BuildUnbindRequestBody ( ) : UnbindRequestBody	Initialize the Unbind request body.
SendAddressBookRequest ( IRequestBody requestBody, RequestType requestType, bool cookieChange = true ) : ChunkedResponse	Send the request to address book server endpoint.

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

public Bind ( uint flags, STAT stat, FlatUID_r &serverGuid ) : 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.
serverGuid	FlatUID_r	The value NULL or a pointer to a GUID value that is associated with the specific server.
return	ErrorCodeValue

Initializes a new instance of the NspiMapiHttpAdapter class.

public NspiMapiHttpAdapter ( ITestSite site, string userName, string password, string domainName, string addressBookUrl ) : System
site	ITestSite	The Site instance.
userName	string	The Mailbox userName which can be used by client to connect to the SUT.
password	string	The user password which can be used by client to access to the SUT.
domainName	string	Define the name of domain where the server belongs to.
addressBookUrl	string	The URL that a client can use to connect with a NSPI server through MAPI over HTTP.
return	System

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

public QueryRows ( uint flags, STAT &stat, uint tableCount, uint table, uint count, PropertyTagArray_r propTags, PropertyRowSet_r &rows ) : 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.
return	ErrorCodeValue

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

public Unbind ( uint reserved ) : uint
reserved	uint	A DWORD [MS-DTYP] value reserved for future use. This property is ignored by the server.
return	uint