F_VN_GetContainer

F_VN_GetContainer 1:

Gets a pointer to the current element converted into an ITcVnContainer interface and increment its reference counter (only possible for container types). (Alternatively use interface method .GetContainer.)

Syntax

Definition:

FUNCTION F_VN_GetContainer : HRESULT
VAR_INPUT
    ipIterator  : ITcVnForwardIterator;
    ipContainer : Reference To ITcVnContainer;
    hrPrev      : HRESULT;
END_VAR

F_VN_GetContainer 2: Inputs

Name

Type

Description

ipIterator

ITcVnForwardIterator

Iterator

ipContainer

Reference To ITcVnContainer

Returns the container interface

hrPrev

HRESULT

HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

F_VN_GetContainer 3: Return value

HRESULT

Further information

F_VN_GetContainer 4:

Deep copy

This function creates a deep copy of the container element. This means that if you wish to change the element in the container, you must write the changes back to the container separately.

If you wish to increment the iterator at the same time as accessing the container element, the expert version F_VN_GetContainerExp is available for this.

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