F_VN_AdvanceIterator
Advance an iterator by the specified offset.
Syntax
Definition:
FUNCTION F_VN_AdvanceIterator : HRESULT
VAR_INPUT
ipIterator : ITcVnForwardIterator;
nOffset : LINT;
hrPrev : HRESULT;
END_VAR
Inputs
|
Name |
Type |
Description |
|---|---|---|
|
ipIterator |
Iterator to be advanced | |
|
nOffset |
LINT |
Offset, by which ipIterator is advanced |
|
hrPrev |
HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.) |
Return valueWeiterführende Informationen
Die Funktion F_VN_AdvanceIterator inkrementiert oder dekrementiert einen Iterator um einen bestimmten Offset nOffset.
Wenn der Offset nOffset immer 1 sein soll, kann ebenfalls die einfachere Funktion F_VN_IncrementIterator verwendet werden.
Parameter
Iterator
Der Parameter ipIterator ist vom Typ ITcVnForwardIterator. Da ITcVnBidirectionalIterator und ITcVnRandomAccessIterator davon erben, können diese ebenfalls an die Funktion übergeben werden. Falls ein Vorwärts-Iterator dekrementiert werden soll, wird intern versucht, diesen in einen bidirektionalen Iterator umzuwandeln und diesen zu dekrementieren.
Offset
Das Offset nOffset legt fest, um wie viel der Iterator ipIterator inkrementiert oder dekrementiert wird. Bei nOffset > 0 wird inkrementiert; bei nOffset < 0 wird dekrementiert.
Verwandte Funktionen
Required License
TC3 Vision Base
System Requirements
Development environment | Target platform | PLC libraries to include |
|---|---|---|
TwinCAT V3.1. 4024.44 or later | PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU | Tc3_Vision |