Returns the entry at the current position. The current position is left unchanged.
#include <nwnet.h>
or
#include <nwitr.h>
NWDSCCODE NWDSItrGetCurrent (
nuint_ptr Iterator,
pnint32 pIterationHandle,
pBuf_T pData);
(IN) Specifies the iterator object.
(IN/OUT) Must be initialized to -1 and will be returned as -1 when all data has been read.
(OUT) Points to the current entry.
|
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 |
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.