ListBegin()

EXTERN_C HCHSVLISTITERATOR Chusov::ListBegin ( HCHSVLIST  hList )

noexcept

Returns a handle to the iterator bound with the first element of the list.

Parameters

hList

is a handle to the list.

Returns

On success the function returns a handle to the iterator bound with the first element of the list.
If the list is empty the function returns LIST_ITERATOR_DOES_NOT_EXIST (NULL).
If any other error occurs the function returns LIST_ITERATOR_ERROR ((HCHSVLISTITERATOR) -1).

Remarks

The list is not thread-safe.

The returned handle to the iterator does not need to be closed.

Declared in chsvlist.h.