NWDSCloseIteration(3nw)

Synopsis

   #include <nwnet.h> 
   or 
   #include <nwdsmisc.h> 
   #include <nwdsdefs.h> 
   
 
   NWDSCCODE N_API NWDSCloseIteration 
     (NWDSContextHandle   context, 
      int32              iterationHandle, 
      uint32             operation); 

Description

context

(IN) Specifies the Directory context for the request.

iterationHandle

(IN) Specifies the iteration handle previously received from the server.

operation

(IN) Specifies the Directory operation associated with iterationHandle.

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

Notices

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 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.

operation tags follow:

	Allocation Type	Related Function
3	DSV_READ	NWDSExtSyncReadNWDSListAttrsEffectiveRights NWDSReadNWDSReadReferences
4	DSV_COMPARE	NWDSCompare
6	DSV_SEARCH	NWDSExtSyncListNWDSExtSyncSearch NWDSListByClassAndNameNWDSListContainers NWDSPutFilterNWDSSearch
7	DSV_ADD_ENTRY	NWDSAddObject
9	DSV_MODIFY_ENTRY	NWDSModifyObject
12	DSV_READ_ATTR_DEF	NWDSReadAttrDef
14	DSV_DEFINE_CLASS	NWDSDefineClass
15	DSV_READ_CLASS_DEF	NWDSReadClassDef
16	DSV_MODIFY_CLASS_DEF	NWDSModifyClassDef
18	DSV_LIST_CONTAINABLE_CLASSES	NWDSListContainableClasses
20	DSV_ADD_PARTITION	NWDSAddPartition
22	DSV_LIST_PARTITIONS	NWDSListPartitions
45	DSV_BACKUP_ENTRY	NWDSBackupObject
46	DSV_RESTORE_ENTRY	NWDSRestoreObject

 
 ------------------------------------------------------------------------------------ 
|      |  Allocation Type             |  Related Function                           | 
|------|------------------------------|---------------------------------------------| 
| 3    |  DSV_READ                    |  NWDSExtSyncReadNWDSListAttrsEffectiveRights| 
|      |                              |  NWDSReadNWDSReadReferences                 | 
|------|------------------------------|---------------------------------------------| 
| 4    |  DSV_COMPARE                 |  NWDSCompare                                | 
|------|------------------------------|---------------------------------------------| 
| 6    |  DSV_SEARCH                  |  NWDSExtSyncListNWDSExtSyncSearch           | 
|      |                              |  NWDSListByClassAndNameNWDSListContainers   | 
|      |                              |  NWDSPutFilterNWDSSearch                    | 
|------|------------------------------|---------------------------------------------| 
| 7    |  DSV_ADD_ENTRY               |  NWDSAddObject                              | 
|------|------------------------------|---------------------------------------------| 
| 9    |  DSV_MODIFY_ENTRY            |  NWDSModifyObject                           | 
|------|------------------------------|---------------------------------------------| 
| 12   |  DSV_READ_ATTR_DEF           |  NWDSReadAttrDef                            | 
|------|------------------------------|---------------------------------------------| 
| 14   |  DSV_DEFINE_CLASS            |  NWDSDefineClass                            | 
|------|------------------------------|---------------------------------------------| 
| 15   |  DSV_READ_CLASS_DEF          |  NWDSReadClassDef                           | 
|------|------------------------------|---------------------------------------------| 
| 16   |  DSV_MODIFY_CLASS_DEF        |  NWDSModifyClassDef                         | 
|------|------------------------------|---------------------------------------------| 
| 18   |  DSV_LIST_CONTAINABLE_CLASSES|  NWDSListContainableClasses                 | 
|------|------------------------------|---------------------------------------------| 
| 20   |  DSV_ADD_PARTITION           |  NWDSAddPartition                           | 
|------|------------------------------|---------------------------------------------| 
| 22   |  DSV_LIST_PARTITIONS         |  NWDSListPartitions                         | 
|------|------------------------------|---------------------------------------------| 
| 45   |  DSV_BACKUP_ENTRY            |  NWDSBackupObject                           | 
|------|------------------------------|---------------------------------------------| 
| 46   |  DSV_RESTORE_ENTRY           |  NWDSRestoreObject                          | 
|------|------------------------------|---------------------------------------------| 

Services

Directory

NCP calls

References