NWDSItrGetInfo

Returns information about an iterator object.

Local Servers:blocking

Remote Servers:blocking

NetWare Server:4.x, 5.x, 6.x

Platform:NLM, Windows NT, Windows 95, Windows 98

Library:Cross-Platform NDS (NET*.*)

Service:NDS Iterator

Syntax

  #include <nwnet.h> 
  or 
  #include <nwitr.h> 
   
  NWDSCCODE  NWDSItrGetInfo ( 
     nuint_ptr    Iterator, 
     pnbool8      pIsScalable, 
     pnbool8      pIsPositionable);

Parameters

Iterator

(IN) Specifies the iterator object.

pIsScalable

(OUT) Points to a value that specifies whether the iterator object was created on a server running NDS 8 (optional).

N_TRUE	Indicates the iterator is on an NDS 8 server
N_FALSE	Indicates the iterator is running in emulation mode on an NDS/eDirectory server that is not running NDS 8.

pIsPositionable

(OUT) Points to a value that specifies whether the iterator object is positionable (optional).

N_TRUE	Indicates that the positioning functions work with this iterator.
N_FALSE	Indicates that the positioning functions don't work with this iterator.

Return Values

0x0000 0000	SUCCESSFUL
zero value	Nonzero values indicate errors. See NDS Return Values (-001 to -799).

Remarks

An N_TRUE value for the pIsPositionable parameter indicates that the NWDSItrGetPosition and NWDSItrSetPosition functions work with this iterator. An iterator created on a eDirectory server not running NDS 8 always returns N_TRUE.

Iterator objects are positionable if they also use a search filter that uses only the same attributes as the index. For example, if an iterator object uses the _BaseClass, _RDN index, the search filter must use only the _BaseClass and the _RDN symbols for attributes for the iterator to be positionable. For example, the following search filters would make the iterator positionable:

"BaseClass=*"
"BaseClass=User"
"RDN=S*"
"BaseClass=User AND RDN=S*"

There are other conditions that can cause an iterator to be nonpositionable. For more information, see Search Filters.

For sample code, see Section 4.5, Getting Iterator Information: Example.

NCP Calls

None