Frees memory associated with an iteration handle in the event the client chooses to discontinue iterative calls to the server.
#include <nwnet.h>
or
#include <nwdsmisc.h>
#include <nwdsdefs.h>
N_EXTERN_LIBRARY (NWDSCCODE) NWDSCloseIteration (
NWDSContextHandle context,
nint32 iterationHandle,
nuint32 operation);
uses netwin32
Function NWDSCloseIteration
(context : NWDSContextHandle;
iterationHandle : nint32;
operation : nuint32
) : NWDSCCODE;
(IN) Specifies the NDS context for the request.
(IN) Specifies the iteration handle previously received from the server.
(IN) Specifies the eDirectory operation associated with iterationHandle (see Section 5.3, Buffer Operation Types and Related Functions).
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 |
NWDSCloseIteration is called to discontinue an iterative operation, such as read, list, and search, before the operation is complete. In the event the client chooses to discontinue the iterative exchange with the server, NWDSCloseIteration frees memory on both the client and the server and states information associated with the handle.
Functions such as NWDSList, NWDSRead, and NWDSSearch free the memory and state information associated with an operation when they return with iterationHandle set to NO_MORE_ITERATIONS. NWDSCloseIteration is called to stop the operation before these functions set iterationHandle to NO_MORE_ITERATIONS.