Synopsis

(macro) PDX_MSGT oqm_ResetCycle(long option, OQM_QUEUE *queue)

Purpose

Reset a queue to the first element.

Description

This function will reset the queue to the first element so that a subsequent call to oqm_CycleQueue 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 queue was encountered. Normally this function does not need to be called because additions and deletions cause the queue to be reset.

Input

option

Options (not used)

queue

Queue pointer

Return

OQM_NOERR or error