Synopsis

(macro) PDX_MSGT olm_ResetCycle(long option, OLM_LIST *list)

Purpose

Reset a list to the first element.

Description

This function will reset the list to the first element so that a subsequent call to olm_CycleList will start the cycle at the first element. This allows an application to force the cycle to start at the first element when it is unknown if the last cycle was aborted before the end of list was encountered. Normally this function does not need to be called because additions and deletions cause the list to be reset.

Input

option

Options (not used)

list

List pointer

Return

OLM_NOERR or error