DynamicTextIterateIndices (FUN)

FUNCTION DynamicTextIterateIndices : RTS_IEC_RESULT

This function can be used to iterate over all indices of a given textlist. An according callback will be called once for each entry in the textlist. Please remark: The order of the entries that are returned may be undefined.

InOut:

Scope

Name

Type

Comment

Return

DynamicTextIterateIndices

RTS_IEC_RESULT

Input

pstTextList

POINTER TO STRING

The name of the textlist that should be iterated

pfIterationCallback

POINTER TO BYTE

The callback function that will be called for every index in the textlist The expected signature is a function returning BOOL with two arguments:

  • a POINTER TO STRING argument reflecting an ID within the textlist. The given POINTER should not be stored for time longer than the overall iteration and the

    POINTER should not be dereferenced directly but instead it should be copied to a temporary variable before access.

  • a __UXINT value reflecting the value passed in iterationData

If the callback function returns FALSE, then the iteration will be cancelled.

iterationData

__UXINT

User provided value that will transparently be passed to all calls of pfIterationCallback