ITcVnContainer

Offers an interface for an object container.

Inheritance Hierarchy

ITcUnknown
    ITcVnContainer

ITcVnContainer 1: Methods

Name

Origin

Description

TcAddRef

ITcUnknown

Increments the reference counter.

TcQueryInterface

ITcUnknown

Get a reference to an implemented interface.

TcRelease

ITcUnknown

Decrements the reference counter.

CheckIfBasicContainer

ITcVnContainer

Checks if the container contains only basic (non-container) elements.

CheckIfEmpty

ITcVnContainer

Checks if the container is empty. (Alternatively use F_VN_CheckIfEmpty.)

GetBidirectionalIterator

ITcVnContainer

Gets an interface pointer to a bidirectional iterator (if this iterator type is supported by the container) and increment its reference counter.

GetElementNum

ITcVnContainer

Gets the size (number of elements) of the container. (Alternatively use F_VN_GetNumberOfElements.)

GetElementSize

ITcVnContainer

Gets the size (in byte) of each element in the container.

GetElementTypeGuid

ITcVnContainer

Gets the GUID of the container elements.

GetExportSize

ITcVnContainer

Gets combined size (in byte) of all elements in the container.

GetForwardIterator

ITcVnContainer

Gets an interface pointer to a forward iterator (if this iterator type is supported by the container) and increment its reference counter. (Alternatively use F_VN_GetForwardIterator.)

GetRandomAccessIterator

ITcVnContainer

Gets an interface pointer to a random access iterator (if this iterator type is supported by the container) and increment its reference counter. (Alternatively use F_VN_GetRandomAccessIterator.)

GetTypeGuid

ITcVnContainer

Gets GUID of the container.

GetTypeName

ITcVnContainer

Gets the container type name as a string.

Further information

The interface ITcVnContainer is for handling containers. Observe the notes in the chapter Interface pointers.

ITcVnContainer 2:

Overwriting containers

Generally, containers with API functions can simply be overwritten. At present, however, overwriting is not possible if the existing container and the container to be written are of different types. This is signaled by the error code 70E (INCOMPATIBLE).

Related functions

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