Returns the names of the object classes that can be contained by (subordinate to) the specified object in the eDirectory tree.
#include <nwnet.h>
or
#include <nwdssch.h>
N_EXTERN_LIBRARY (NWDSCCODE) NWDSListContainableClasses (
NWDSContextHandle context,
pnstr8 parentObject,
pnint_ptr iterationHandle,
pBuf_T containableClasses);
uses netwin32
Function NWDSListContainableClasses
(context : NWDSContextHandle;
parentObject : pnstr8;
iterationHandle : pnint_ptr;
containableClasses : pBuf_T
) : NWDSCCODE;
(IN) Specifies the NDS context for the request.
(IN) Points to the name of the parent object for which containable classes are to be listed.
(IN/OUT) Points to the information needed to resume subsequent iterations of NWDSListContainableClasses.
(OUT) Points to a buffer containing the names of object classes contained by the specified parent object.
These are common return values.
|
0x0000 0000 |
SUCCESSFUL |
|
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 eDirectory |
|
nonzero value |
Nonzero values indicate errors. See |
NWDSListContainableClasses can be used to build a list of object classes that can be used to create objects subordinate to the parent object specified by parentObject.
The parentObject parameter points to the name of an eDirectory object for which containable object-classes are to be listed. If this parent object is not a valid container object, an error is returned.
The iterationHandle parameter controls retrieval of results larger than the buffer pointed to by containableClasses.
Before the initial call to NWDSListContainableClasses, set the contents of the iteration handle pointed to by iterationHandle to NO_MORE_ITERATIONS.
If the result buffer holds the complete results when NWDSListContainableClasses 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 class to NWDSListContainableClasses to obtain further portions of the results. When the results are completely retrieved, the contents of the iteration handle will be set to NO_MORE_ITERATIONS.
NOTE:To end the List operation before all of the results have been retrieved, call NWDSCloseIteration with a value of DSV_LIST_CONTAINABLE_CLASSES to free memory and states associated with NWDSListContainableClasses.
The level of granularity for partial results (those split across multiple iterations) is an individual class name.
The containableClasses parameter points to a result buffer that receives the list of names of object classes that can be used to create objects contained by the specified parent object. The result buffer contains the names of only the object classes marked as effective in the eDirectory Schema (those from which objects can be created). Alias is always included in the list.
For more information, see Listing Containable Classes.