NWDSListContainers(3nw)
NWDSListContainers --
lists container objects subordinate to a specific Directory object
Synopsis
#include <nwnet.h>
or
#include <nwdsdsa.h>
NWDSCCODE N_API NWDSListContainers
(NWDSContextHandle context,
pnstr8 object,
pnint32 iterationHandle,
pBuf_T subordinates);
Description
The parameters are as follows:
- context
-
(IN) Specifies the Directory context for the request.
- object
-
(IN) Points to the name of the object whose subordinate container objects are to be listed.
- iterationHandle
-
(IN/OUT) Points to information needed to resume subsequent iterations of NWDSListContainers. This should be initially set to NO_MORE_ITERATIONS.
- subordinates
-
(OUT) Points to a result buffer containing a list of subordinate container objects.
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).
- 0x8996
-
SERVER_OUT_OF_MEMORY
- 0x89E2
-
TOO_FEW_FRAGMENTS
- 0x89E3
-
TOO_MANY_FRAGMENTS
- 0x89E4
-
PROTOCOL_VIOLATION
- 0x89E5
-
SIZE_LIMIT_EXCEEDED
- 0x89FD
-
UNKNOWN_REQUEST
- 0x89FD
-
INVALID_PACKET_LENGTH
- 0x89FE
-
BAD_PACKET
- 0x89FF
-
Failure not related to Directory Services
- 0xFFFFFE01
-
ERR_BAD_CONTEXT
- 0xFFFFFE0D
-
UNI_NO_DEFAULT
- 0xFFFFFE0F
-
UNI_HANDLE_MISMATCH
Notices
The name specified by objectName is relative to the current name context in context. It can be typed or untyped.
iterationHandle controls retrieval of search results larger than the result buffer pointed to by subordinates.
Before the initial call to NWDSListContainers, set the contents of
the iteration handle pointed to by iterationHandle to
NO_MORE_ITERATIONS.
If the result buffer holds the complete results when NWDSListContainers returns from its initial call, the location pointed to by iterationHandle is set to
NO_MORE_ITERATIONS. If iterationHandle
is not set to NO_MORE_ITERATIONS, use the iteration handle for subsequent calls to NWDSListContainers in order to obtain further portions of the results. When the
results are completely retrieved, the contents of iterationHandle
will be set to NO_MORE_ITERATIONS.
To end the List operation before the complete results have been retrieved,
call NWDSCloseIteration with a value of DSV_SEARCH to free
memory and states associated with the List operation.
The contents of the result buffer pointed to by subordinates are overwritten with each subsequent call to NWDSListContainers. Remove the contents from the
result buffer before each subsequent call to NWDSListContainers.
Allocate the result buffer pointed to by subordinates, by calling NWDSAllocBuf. This result buffer does not need to be initialized because it is a result
buffer.
Follow these steps to remove the contents from the results buffer:
-
Determine the number of objects in the result buffer by calling NWDSGetObjectCount.
-
Remove the object names from the result buffer by calling NWDSGetObjectName once for each object name in the result buffer.
Services
Directory
NCP calls
- 0x2222 23 17
-
Get File Server Information
- 0x2222 23 22
-
Get Station's Logged Info (old)
- 0x2222 23 28
-
Get Station's Logged Info
- 0x2222 104 01
-
Ping for NDS NCP
- 0x2222 104 02
-
Send NDS Fragmented Request/Reply
References
NWDSCloseIteration(3nw),
NWDSList(3nw)
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.