F_VN_GetContainerExp
Gets a pointer to the current element converted into an ITcVnContainer interface and increment its reference counter (only possible for container types). Additionally, an offset to increment or decrement the iterator afterwards can be provided. (expert function)
Syntax
Definition:
FUNCTION F_VN_GetContainerExp : HRESULT
VAR_INPUT
ipIterator : ITcVnForwardIterator;
ipContainer : Reference To ITcVnContainer;
nOffset : DINT;
hrPrev : HRESULT;
END_VAR
Inputs
|
Name |
Type |
Description |
|---|---|---|
|
ipIterator |
Iterator | |
|
ipContainer |
Reference To ITcVnContainer |
Returns the container interface |
|
nOffset |
DINT |
Offset to increment (>0) or decrement (<0) the iterator afterwards |
|
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_GetContainerExp ist die Expert-Variante von F_VN_GetContainer. Sie hilft Ihnen, wenn Sie gleichzeitig mit dem Zugreifen auf ein Container-Element mittels Iterator auch diesen Iterator inkrementieren möchten. Setzen Sie den Parameter nOffset für ein normales, sequenzielles Inkrementieren auf den Wert 1:
hr := F_VN_GetContainerExp(ipIterator, ipElement, 1, hr);
Mit der Standard-Funktion würden Sie dafür zwei Funktionsaufrufe benötigen:
hr := F_VN_GetContainer(ipIterator, ipElement, hr);
hr := F_VN_IncrementIterator(ipIterator, hr);
Required License
TC3 Vision Base
System Requirements
Development environment | Target platform | PLC libraries to include |
|---|---|---|
TwinCAT V3.1.4024.54 or later | PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU | Tc3_Vision |