C# Class Microsoft.Protocols.TestSuites.MS_OXNSPI.MS_OXNSPIAdapter

Server role and both role Adapter requirements capture code for MS-OXNSPI.

Inheritance: Microsoft.Protocols.TestTools.ManagedAdapterBase, IMS_OXNSPIAdapter

Afficher le fichier Open project: OfficeDev/Interop-TestSuites

Méthodes publiques

Méthode	Description
Initialize ( ITestSite testSite ) : void	Initializes the current adapter instance associated with a test site.
NspiBind ( uint flags, STAT stat, FlatUID_r &serverGuid, bool needRetry = true ) : ErrorCodeValue	The NspiBind method initiates a session between a client and the server.
NspiCompareMIds ( uint reserved, STAT stat, uint mid1, uint mid2, int &results, bool needRetry = true ) : ErrorCodeValue	The NspiCompareMIds method compares the position in an address book container of two objects identified by Minimal Entry ID and returns the value of the comparison.
NspiDNToMId ( uint reserved, StringsArray_r names, PropertyTagArray_r &mids, bool needRetry = true ) : ErrorCodeValue	The NspiDNToMId method maps a set of DN to a set of Minimal Entry ID.
NspiGetMatches ( uint reserved, STAT &stat, PropertyTagArray_r proReserved, uint reserved2, Restriction_r filter, PropertyName_r propName, uint requested, PropertyTagArray_r &outMids, PropertyTagArray_r propTags, PropertyRowSet_r &rows, bool needRetry = true ) : ErrorCodeValue	The NspiGetMatches method returns an Explicit Table.
NspiGetPropList ( uint flags, uint mid, uint codePage, PropertyTagArray_r &propTags, bool needRetry = true ) : ErrorCodeValue	The NspiGetPropList method returns a list of all the properties that have values on a specified object.
NspiGetProps ( uint flags, STAT stat, PropertyTagArray_r propTags, PropertyRow_r &rows, bool needRetry = true ) : ErrorCodeValue	The NspiGetProps method returns an address book row that contains a set of the properties and values that exist on an object.
NspiGetSpecialTable ( uint flags, STAT &stat, uint &version, PropertyRowSet_r &rows, bool needRetry = true ) : ErrorCodeValue	The NspiGetSpecialTable method returns the rows of a special table to the client.
NspiGetTemplateInfo ( uint flags, uint type, string dn, uint codePage, uint localeID, PropertyRow_r &data, bool needRetry = true ) : ErrorCodeValue	The NspiGetTemplateInfo method returns information about template objects.
NspiModLinkAtt ( uint flags, uint propTag, uint mid, BinaryArray_r entryIds, bool needRetry = true ) : ErrorCodeValue	The NspiModLinkAtt method modifies the values of a specific property of a specific row in the address book.
NspiModProps ( uint reserved, STAT stat, PropertyTagArray_r propTags, PropertyRow_r row, bool needRetry = true ) : ErrorCodeValue	The NspiModProps method is used to modify the properties of an object in the address book.
NspiQueryColumns ( uint reserved, uint flags, PropertyTagArray_r &columns, bool needRetry = true ) : ErrorCodeValue	The NspiQueryColumns method returns a list of all the properties that the server is aware of.
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.
NspiResolveNames ( uint reserved, STAT stat, PropertyTagArray_r propTags, StringsArray_r stringArray, PropertyTagArray_r &mids, PropertyRowSet_r &rows, bool needRetry = true ) : ErrorCodeValue	The NspiResolveNames method takes a set of string values in an 8-bit character set and performs ANR on those strings. The NspiResolveNames method taking string values in an 8-bit character set is not supported when mapi_http transport is used.
NspiResolveNamesW ( uint reserved, STAT stat, PropertyTagArray_r propTags, WStringsArray_r wstr, PropertyTagArray_r &mids, PropertyRowSet_r &rowOfResolveNamesW, bool needRetry = true ) : ErrorCodeValue	The NspiResolveNamesW method takes a set of string values in the Unicode character set and performs ANR on those strings.
NspiResortRestriction ( uint reserved, STAT &stat, PropertyTagArray_r proInMIds, PropertyTagArray_r &outMIds, bool needRetry = true ) : ErrorCodeValue	The NspiResortRestriction method applies to a sort order to the objects in a restricted address book container.
NspiSeekEntries ( uint reserved, STAT &stat, PropertyValue_r target, PropertyTagArray_r table, PropertyTagArray_r propTags, PropertyRowSet_r &rows, bool needRetry = true ) : ErrorCodeValue	The NspiSeekEntries method searches for and sets the logical position in a specific table to the first entry greater than or equal to a specified value.
NspiUnbind ( uint reserved ) : uint	The NspiUnbind method destroys the context handle. No other action is taken.
NspiUpdateStat ( uint reserved, STAT &stat, int &delta, bool needRetry = true ) : ErrorCodeValue	The NspiUpdateStat method updates the STAT block that represents the position in a table to reflect positioning changes requested by the client.
Reset ( ) : void	Release the test site.

Méthodes protégées

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

Private Methods

Méthode	Description
InitializeRPC ( ) : void	Initialize the client and server and build the transport tunnel between client and server.
VerifyBinaryArray_r ( BinaryArray_r binaryArray ) : void	Verify BinaryArray_r structure.
VerifyBinary_r ( Binary_r binary ) : void	Verify Binary_r structure.
VerifyContainerIDCanNotBeModified ( STAT inputStat, STAT outputStat ) : void	Verify that ContainerID in STAT cannot be modified.
VerifyDisplayType ( DisplayTypeValue displayTypeValue ) : void	Verify the display type related requirements.
VerifyEphemeralEntryID ( EphemeralEntryID ephemeralEntryID ) : void	Verify the EphemeralEntryID structure.
VerifyFlatUID_r ( ) : void	Verify FlatUID_r structure.
VerifyMinimalEntryIDStructure ( ) : void	Verify the MinimalEntryID structure.
VerifyMustReturnPtyp ( ) : void	Verify the property type related requirements.
VerifyMustReturnPtypAddition ( ) : void	Verify the additional property type related requirements.
VerifyNspiBind ( ) : void	The capture code in NspiBind.
VerifyNspiCompareMIds ( ErrorCodeValue returnValue ) : void	The capture code in NspiCompareMIds.
VerifyNspiDNToMId ( ErrorCodeValue returnValue, PropertyTagArray_r mids ) : void	The capture code in NspiDNToMId.
VerifyNspiGetMatches ( ErrorCodeValue returnValue, PropertyRowSet_r rows, PropertyTagArray_r outMIds, STAT inputStat, STAT outputStat ) : void	The capture code in NspiGetMatches.
VerifyNspiGetPropList ( ErrorCodeValue returnValue, PropertyTagArray_r propTags ) : void	The capture code in NspiGetPropList.
VerifyNspiGetProps ( ErrorCodeValue returnValue, PropertyRow_r propertyRow ) : void	The capture code in NspiGetProps.
VerifyNspiGetSpecialTable ( ErrorCodeValue returnValue, PropertyRowSet_r rows ) : void	The capture code in NspiGetSpecialTable.
VerifyNspiGetTemplateInfo ( ErrorCodeValue returnValue, uint flags, PropertyRow_r data ) : void	The capture code in NspiGetTemplateInfo.
VerifyNspiModLinkAtt ( ErrorCodeValue returnValue ) : void	The capture code in NspiModLinkAtt.
VerifyNspiModProps ( ErrorCodeValue returnValue ) : void	The capture code in NspiModProps.
VerifyNspiQueryColumns ( ErrorCodeValue returnValue, PropertyTagArray_r columns ) : void	The capture code in NspiQueryColumns.
VerifyNspiQueryRows ( ErrorCodeValue returnValue, PropertyRowSet_r rows, STAT inputStat, STAT outputStat ) : void	The capture code in NspiQueryRows.
VerifyNspiResolveNames ( ErrorCodeValue returnValue, PropertyTagArray_r mids, PropertyRowSet_r rows ) : void	The capture code in NspiResolveNames.
VerifyNspiResolveNamesW ( ErrorCodeValue returnValue, PropertyTagArray_r mids, PropertyRowSet_r rows ) : void	The capture code in NspiResolveNamesW.
VerifyNspiResortRestriction ( ErrorCodeValue returnValue, PropertyTagArray_r outMIds, STAT inputStat, STAT outputStat ) : void	The capture code in NspiResortRestriction.
VerifyNspiSeekEntries ( ErrorCodeValue returnValue, PropertyRowSet_r rows, STAT inputStat, STAT outputStat ) : void	The capture code in NspiSeekEntries.
VerifyNspiUnbind ( IntPtr contextHandle ) : void	The capture code in NspiUnbind.
VerifyNspiUpdateStat ( ErrorCodeValue returnValue, STAT inputStat, STAT outputStat ) : void	The capture code in NspiUpdateStat.
VerifyNspihandle ( ) : void	Verify The NSPI_HANDLE definition.
VerifyPROP_VAL_UNION ( PropertyValue_r propertyValue ) : void	Verify PropertyValue_r structure.
VerifyPermanentEntryID ( PermanentEntryID permanentEntryID ) : void	Verify the PermanentEntryID structure.
VerifyPropertyRowSetStructure ( PropertyRowSet_r propertyRowSet ) : void	Verify PropertyRowSet_r structure.
VerifyPropertyRowStructure ( PropertyRow_r propertyRow ) : void	Verify PropertyRow_r structure.
VerifyPropertyStructures ( ) : void	Property values' structure verification.
VerifyPropertyTag ( uint propertyTag ) : void	Verify property value Types.
VerifyPropertyTagArray_r ( ) : void	Verify PropertyTagArray_r structure.
VerifyPropertyValueStructure ( PropertyValue_r propertyValue ) : void	Verify PropertyValue_r structure.
VerifyReturnValues ( ErrorCodeValue errorCode ) : void	Verify that the return values of the NSPI operation used by the server are valid.
VerifySTATStructure ( ErrorCodeValue returnValue, STAT inputStat, STAT outputStat, bool isNspiGetMatches ) : void	Verify The STAT structure.
VerifyStringOrString8Value ( PropertyRow_r returnedRows ) : void	Verify that the string values can be represented as Unicode string or 8-bit character string values.
VerifyThreePossbleOutcomesOfANRProcess ( PropertyTagArray_r mids, PropertyRowSet_r rows ) : void	Verify there are three possible outcomes to the ANR process.
VerifyTransport ( ) : void	Verify the transport related requirements.
VerifyWstringArray_r ( WStringArray_r wstringArray ) : void	Verify WStringArray_r structure.
VerifystringArray_r ( StringArray_r stringArray ) : void	Verify StringArray_r structure.

Method Details

Dispose() protected méthode

This method is used to implement clean-up codes.

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

Initialize() public méthode

Initializes the current adapter instance associated with a test site.

public Initialize ( ITestSite testSite ) : void
testSite	ITestSite	The test site instance associated with the current adapter.
Résultat	void

NspiBind() public méthode

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.
Résultat	ErrorCodeValue

NspiCompareMIds() public méthode

The NspiCompareMIds method compares the position in an address book container of two objects identified by Minimal Entry ID and returns the value of the comparison.

public NspiCompareMIds ( uint reserved, STAT stat, uint mid1, uint mid2, int &results, bool needRetry = true ) : ErrorCodeValue
reserved	uint	A DWORD value reserved for future use. Ignored by the server.
stat	STAT	A STAT block that describes a logical position in a specific address book container.
mid1	uint	The mid1 is a DWORD value containing a Minimal Entry ID.
mid2	uint	The mid2 is a DWORD value containing a Minimal Entry ID.
results	int	A DWORD value. On return, it contains the result of the comparison.
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.
Résultat	ErrorCodeValue

NspiDNToMId() public méthode

The NspiDNToMId method maps a set of DN to a set of Minimal Entry ID.

public NspiDNToMId ( uint reserved, StringsArray_r names, PropertyTagArray_r &mids, bool needRetry = true ) : ErrorCodeValue
reserved	uint	A DWORD value reserved for future use. Ignored by the server.
names	StringsArray_r	A StringsArray_r value. It holds a list of strings that contain DNs.
mids	PropertyTagArray_r	A PropertyTagArray_r value. On return, it holds a list of Minimal Entry IDs.
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.
Résultat	ErrorCodeValue

NspiGetMatches() public méthode

The NspiGetMatches method returns an Explicit Table.

public NspiGetMatches ( uint reserved, STAT &stat, PropertyTagArray_r proReserved, uint reserved2, Restriction_r filter, PropertyName_r propName, uint requested, PropertyTagArray_r &outMids, PropertyTagArray_r propTags, PropertyRowSet_r &rows, bool needRetry = true ) : ErrorCodeValue
reserved	uint	A DWORD value reserved for future use.
stat	STAT	A STAT block describing a logical position in a specific address book container.
proReserved	PropertyTagArray_r	A PropertyTagArray_r reserved for future use.
reserved2	uint	A DWORD value reserved for future use. Ignored by the server.
filter	Restriction_r	The value NULL or a Restriction_r value. /// It holds a logical restriction to apply to the rows in the address book container specified in the stat parameter.
propName	PropertyName_r	The value NULL or a PropertyName_r value. /// It holds the property to be opened as a restricted address book container.
requested	uint	A DWORD value. It contains the maximum number of rows to return in a restricted address book container.
outMids	PropertyTagArray_r	A PropertyTagArray_r value. On return, it holds a list of Minimal Entry IDs that comprise a restricted address book container.
propTags	PropertyTagArray_r	The value NULL or a reference to a PropertyTagArray_r value. /// It contains a list of the proptags of the columns that client wants to be returned for each row returned.
rows	PropertyRowSet_r	A reference to a PropertyRowSet_r value. It contains the address book container rows the server returns in response to the request.
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.
Résultat	ErrorCodeValue

NspiGetPropList() public méthode

The NspiGetPropList method returns a list of all the properties that have values on a specified object.

public NspiGetPropList ( uint flags, uint mid, uint codePage, PropertyTagArray_r &propTags, bool needRetry = true ) : ErrorCodeValue
flags	uint	A DWORD value that contains a set of bit flags.
mid	uint	A DWORD value that contains a Minimal Entry ID.
codePage	uint	The code page in which the client wants the server to express string values properties.
propTags	PropertyTagArray_r	A PropertyTagArray_r value. On return, it holds a list of properties.
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.
Résultat	ErrorCodeValue

NspiGetProps() public méthode

The NspiGetProps method returns an address book row that contains a set of the properties and values that exist on an object.

public NspiGetProps ( uint flags, STAT stat, PropertyTagArray_r propTags, PropertyRow_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.
propTags	PropertyTagArray_r	The value NULL or a reference to a PropertyTagArray_r value. /// It contains a list of the proptags of the properties that the client wants to be returned.
rows	PropertyRow_r	A nullable PropertyRow_r value. /// It contains the address book container row the server returns in response to the request.
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.
Résultat	ErrorCodeValue

NspiGetSpecialTable() public méthode

The NspiGetSpecialTable method returns the rows of a special table to the client.

public NspiGetSpecialTable ( uint flags, STAT &stat, uint &version, PropertyRowSet_r &rows, 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.
version	uint	A reference to a DWORD. On input, it holds the value of the version number of /// the address book hierarchy table that the client has. On output, it holds the version of the server's address book hierarchy table.
rows	PropertyRowSet_r	A PropertyRowSet_r structure. On return, it holds the rows for the table that the client is requesting.
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.
Résultat	ErrorCodeValue

NspiGetTemplateInfo() public méthode

The NspiGetTemplateInfo method returns information about template objects.

public NspiGetTemplateInfo ( uint flags, uint type, string dn, uint codePage, uint localeID, PropertyRow_r &data, bool needRetry = true ) : ErrorCodeValue
flags	uint	A DWORD value that contains a set of bit flags.
type	uint	A DWORD value. It specifies the display type of the template for which the information is requested.
dn	string	The value NULL or the DN of the template requested. The value is NULL-terminated.
codePage	uint	A DWORD value. It specifies the code page of the template for which the information is requested.
localeID	uint	A DWORD value. It specifies the LCID of the template for which the information is requested.
data	PropertyRow_r	A reference to a PropertyRow_r value. On return, it contains the information requested.
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.
Résultat	ErrorCodeValue

NspiModLinkAtt() public méthode

The NspiModLinkAtt method modifies the values of a specific property of a specific row in the address book.

public NspiModLinkAtt ( uint flags, uint propTag, uint mid, BinaryArray_r entryIds, bool needRetry = true ) : ErrorCodeValue
flags	uint	A DWORD value that contains a set of bit flags.
propTag	uint	A DWORD value. It contains the proptag of the property that the client wants to modify.
mid	uint	A DWORD value that contains the Minimal Entry ID of the address book row that the client wants to modify.
entryIds	BinaryArray_r	A BinaryArray value. It contains a list of EntryIDs to be used to modify the requested property on the requested address book row.
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.
Résultat	ErrorCodeValue

NspiModProps() public méthode

The NspiModProps method is used to modify the properties of an object in the address book.

public NspiModProps ( uint reserved, STAT stat, PropertyTagArray_r propTags, PropertyRow_r row, bool needRetry = true ) : ErrorCodeValue
reserved	uint	A DWORD value reserved for future use.
stat	STAT	A STAT block that describes a logical position in a specific address book container.
propTags	PropertyTagArray_r	The value NULL or a reference to a PropertyTagArray_r. /// It contains a list of the proptags of the columns from which the client requests all the values to be removed.
row	PropertyRow_r	A PropertyRow_r value. It contains an address book row.
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.
Résultat	ErrorCodeValue

NspiQueryColumns() public méthode

The NspiQueryColumns method returns a list of all the properties that the server is aware of.

public NspiQueryColumns ( uint reserved, uint flags, PropertyTagArray_r &columns, bool needRetry = true ) : ErrorCodeValue
reserved	uint	A DWORD value reserved for future use. Ignored by the server.
flags	uint	A DWORD value that contains a set of bit flags.
columns	PropertyTagArray_r	A PropertyTagArray_r structure that contains a list of proptags.
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.
Résultat	ErrorCodeValue

NspiQueryRows() public méthode

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 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.
Résultat	ErrorCodeValue

NspiResolveNames() public méthode

The NspiResolveNames method takes a set of string values in an 8-bit character set and performs ANR on those strings. The NspiResolveNames method taking string values in an 8-bit character set is not supported when mapi_http transport is used.

public NspiResolveNames ( uint reserved, STAT stat, PropertyTagArray_r propTags, StringsArray_r stringArray, PropertyTagArray_r &mids, PropertyRowSet_r &rows, bool needRetry = true ) : ErrorCodeValue
reserved	uint	A DWORD reserved for future use.
stat	STAT	A STAT block that describes a logical position in a specific address book container.
propTags	PropertyTagArray_r	The value NULL or a reference to a PropertyTagArray_r value containing a list of the proptags of the columns /// that the client requests to be returned for each row returned.
stringArray	StringsArray_r	A StringsArray_r value. It specifies the values on which the client is requesting the server to do ANR.
mids	PropertyTagArray_r	A PropertyTagArray_r value. On return, it contains a list of Minimal Entry IDs that match the array of strings.
rows	PropertyRowSet_r	A reference to a PropertyRowSet_r value. /// It contains the address book container rows that the server returns in response to the request.
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.
Résultat	ErrorCodeValue

NspiResolveNamesW() public méthode

The NspiResolveNamesW method takes a set of string values in the Unicode character set and performs ANR on those strings.

public NspiResolveNamesW ( uint reserved, STAT stat, PropertyTagArray_r propTags, WStringsArray_r wstr, PropertyTagArray_r &mids, PropertyRowSet_r &rowOfResolveNamesW, bool needRetry = true ) : ErrorCodeValue
reserved	uint	A DWORD value that is reserved for future use.
stat	STAT	A STAT block that describes a logical position in a specific address book container.
propTags	PropertyTagArray_r	The value NULL or a reference to a PropertyTagArray_r containing a list of the proptags of the columns /// that the client requests to be returned for each row returned.
wstr	WStringsArray_r	A WStringsArray_r value. It specifies the values on which the client is requesting the server to perform ANR.
mids	PropertyTagArray_r	A PropertyTagArray_r value. On return, it contains a list of Minimal Entry IDs that match the array of strings.
rowOfResolveNamesW	PropertyRowSet_r	A reference to a PropertyRowSet_r structure. It contains the address book container rows that the server returns in response to the request.
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.
Résultat	ErrorCodeValue

NspiResortRestriction() public méthode

The NspiResortRestriction method applies to a sort order to the objects in a restricted address book container.

public NspiResortRestriction ( uint reserved, STAT &stat, PropertyTagArray_r proInMIds, PropertyTagArray_r &outMIds, bool needRetry = true ) : ErrorCodeValue
reserved	uint	A DWORD value reserved for future use. Ignored by the server.
stat	STAT	A reference to a STAT block describing a logical position in a specific address book container.
proInMIds	PropertyTagArray_r	A PropertyTagArray_r value. /// It holds a list of Minimal Entry IDs that comprise a restricted address book container.
outMIds	PropertyTagArray_r	A PropertyTagArray_r value. On return, it holds a list of Minimal Entry IDs /// that comprise a restricted address book container.
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.
Résultat	ErrorCodeValue

NspiSeekEntries() public méthode

The NspiSeekEntries method searches for and sets the logical position in a specific table to the first entry greater than or equal to a specified value.

public NspiSeekEntries ( uint reserved, STAT &stat, PropertyValue_r target, PropertyTagArray_r table, PropertyTagArray_r propTags, PropertyRowSet_r &rows, bool needRetry = true ) : ErrorCodeValue
reserved	uint	A DWORD value that is reserved for future use. Ignored by the server.
stat	STAT	A STAT block that describes a logical position in a specific address book container.
target	PropertyValue_r	A PropertyValue_r value holding the value that is being sought.
table	PropertyTagArray_r	The value NULL or a PropertyTagArray_r value. /// It holds a list of Minimal Entry IDs that comprise a restricted address book container.
propTags	PropertyTagArray_r	It contains a list of the proptags of the columns /// that client wants to be returned for each row returned.
rows	PropertyRowSet_r	It contains the address book container rows the server returns in response to the request.
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.
Résultat	ErrorCodeValue

NspiUnbind() public méthode

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

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

NspiUpdateStat() public méthode

The NspiUpdateStat method updates the STAT block that represents the position in a table to reflect positioning changes requested by the client.

public NspiUpdateStat ( uint reserved, STAT &stat, int &delta, bool needRetry = true ) : ErrorCodeValue
reserved	uint	A DWORD value. Reserved for future use. Ignored by the server.
stat	STAT	A pointer to a STAT block describing a logical position in a specific address book container.
delta	int	The value NULL or a pointer to a LONG value that indicates movement /// within the address book container specified by the input parameter stat.
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.
Résultat	ErrorCodeValue

Reset() public méthode

Release the test site.

public Reset ( ) : void
Résultat	void