Retrieves information about eDirectory schema attribute definitions.
#include <nwnet.h>
or
#include <nwdssch.h>
N_EXTERN_LIBRARY (NWDSCCODE) NWDSReadAttrDef (
NWDSContextHandle context,
nuint32 infoType,
nbool8 allAttrs,
pBuf_T attrNames,
pnint_ptr iterationHandle,
pBuf_T attrDefs);
uses netwin32
Function NWDSReadAttrDef
(context : NWDSContextHandle;
infoType : nuint32;
allAttrs : nbool8;
attrNames : pBuf_T;
iterationHandle : pnint_ptr;
attrDefs : pBuf_T
) : NWDSCCODE;
(IN) Specifies the NDS context for the request.
(IN) Specifies the information type desired (see Section 5.14, Information Types for Attribute Definitions).
(IN) Specifies the scope of the request: TRUE=information concerning all attributes is requested; FALSE=only attributes named in attrNames are requested.
(IN) Points to a request buffer containing the attribute names whose definitions are to be returned.
(IN/OUT) Points to information needed to resume subsequent iterations of NWDSReadAttrDef.
(OUT) Points to a result buffer that receives the requested attribute names and/or definitions.
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 |
The infoType, allAttrs, and attrNames parameters indicate what eDirectory Schema attribute information is requested.
If allAttrs is TRUE, information about all attributes in the eDirectory schema is requested. In this case, attrNames is ignored and can be set to NULL. If allAttrs is FALSE, only the attributes specified by attrNames are requested.
The iterationHandle parameter controls retrieval of results that are larger than the result buffer pointed to by attrDefs.
Before the initial call to NWDSReadAttrDef, set the contents of the iteration handle pointed to by iterationHandle to NO_MORE_ITERATIONS.
If the result buffer holds the complete results when NWDSReadAttrDef returns from its initial call, the location pointed to by iterationHandle is set to NO_MORE_ITERATIONS. If the iteration handle is not set to NO_MORE_ITERATIONS, use the iteration handle for subsequent calls to NWDSReadAttrDef in order 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 Read operation before the complete results have been retrieved, call NWDSCloseIteration with a value of DSV_READ_ATTR_DEF to free memory and states associated with NWDSReadAttrDef.
The level of granularity for partial results is an individual attribute definition.
The attrDefs parameter points to a request buffer containing the requested attribute information. This buffer contains either a list of attribute names, or a sequence of attribute names and definitions depending upon the value of infoType mentioned above.
For step-by-step instructions, see Reading an Attribute Definition.