NWDSItrGetCurrent

Returns the entry at the current position. The current position is left unchanged.

Local Servers:blocking
Remote Servers:blocking
NetWare Server:4.x, 5.x, 6.x
Platform:NLM, Windows NT, Windows 95, Windows 98
Library:Cross-Platform NDS (NET*.*)
Service:NDS Iterator

Syntax

  #include <nwnet.h> 
  or 
  #include <nwitr.h> 
   
  NWDSCCODE  NWDSItrGetCurrent ( 
     nuint_ptr    Iterator, 
     pnint32      pIterationHandle, 
     pBuf_T       pData); 
  
  

Parameters

Iterator

(IN) Specifies the iterator object.

pIterationHandle

(IN/OUT) Must be initialized to -1 and will be returned as -1 when all data has been read.

pData

(OUT) Points to the current entry.

Return Values

0x0000 0000

SUCCESSFUL

ERR_ITR_INVALID_HANDLE

Indicates the Iterator parameter was not a valid iterator object.

ERR_ITR_INVALID_SEARCH_DATA

Indicates entry data is in an unexpected format.

ERR_EOF_HIT

Indicates the iterator is positioned at the end of the list

nonzero value

Nonzero values indicate errors. See NDS Return Values (-001 to -799).

Remarks

If the returned data does not fit in the application’s buffer, the function returns with partial data. You must then call NWDSItrGetCurrent repeatedly with the current value of the iteration handle to get the remaining data. When the iteration handle is returned as -1, all the data has been retrieved.

For sample code, see Section 4.8, Positioning the Iterator with Typedown: Example.

NCP Calls

See Also

NWDSItrGetNext, NWDSItrGetPrev, NWDSItrSkip