NWDSScanForAvailableTrees(3nw)


NWDSScanForAvailableTrees -- scans a connection for tree objects

Synopsis

   #include <nwdsconn.h> 
   

N_EXTERN_LIBRARY (NWDSCCODE) NWDSScanForAvailableTrees (NWDSContextHandle context, NWCONN_HANDLE connHandle, pnstr scanFilter, pnuint32 scanIndex, pnstr treeName);

Description

The parameters are as follows:

context
(IN) Specifies the Directory context for the request.

connHandle
(IN) Specifies the connection handle to be used in scanning for NDS trees.

scanFilter
(IN) Points to an ASCII string which allows wildcards to be specified in the scan.

scanIndex
(IN/OUT) Points to the index to be used on the next iteration of the scan.

treeName
(OUT) Points to the name of the tree found in the scan operation.

Return values

0x0000
SUCCESSFUL

Negative Value
Negative values indicate errors. For errors returned by Directory Services, see ``Directory Services OS Errors'' (-001 to -255), ``Directory Services Client Library Errors'' (-301 to -399), or ``Directory Services Agent in the Server Errors'' (-601 to -699).

Notices

NWDSScanForAvailableTrees uses the connection specified in connHandle to scan for NDS tree objects (object type 0x7802) using the bindery of the server (the dynamic bindery is used for NetWare 4 server). NWScanBindery is used to search for these objects. (See NetWare Client SDK documentation for NWScanBindery to get more information about return codes.)

The scanFilter value allows wildcard matching to be specified for the scan operation. The scanIndex value should be initially set to -1 and must not be altered by the user after the first call.

Unlike other NDS functions, there is no need to call NWDSCloseIteration to discontinue calling NWDSScanForAvailableTrees once the search is begun.

The context parameter is used to determine the character type for the tree name (that is, local code page or Unicode).

Services

Connection (Directory Support)

NCP calls

None

References

NWDSScanConnsForTrees(3nw)


30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.