F_VN_CreateContainerFromArray

F_VN_CreateContainerFromArray 1:

Creates a container with type GUID nTypeGuid, initialize it with provided data and return its container interface. Only supported for basic container types, i.e. not for containers of containers.

Syntax

Definition:

FUNCTION F_VN_CreateContainerFromArray : HRESULT
VAR_INPUT
    pData       : PVOID;
    ipContainer : Reference To ITcVnContainer;
    nTypeGuid   : GUID;
    nElementNum : ULINT;
    hrPrev      : HRESULT;
END_VAR

F_VN_CreateContainerFromArray 2: Inputs

Name

Type

Description

pData

PVOID

Pointer to the data array. Make sure that the array contains at least nElementNum elements and that the array element type matches the container element type.

ipContainer

Reference To ITcVnContainer

Returns the created container

nTypeGuid

GUID

Type GUID of the container to be created

nElementNum

ULINT

Number of elements to copy from pData

hrPrev

HRESULT

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

F_VN_CreateContainerFromArray 3: Return value

HRESULT

Further information

The global ContainerType constants can be used to determine the container type via the parameter nTypeGuid.

Since the array data is only specified via a pointer, a type check within the function is not possible. Therefore, please note the following warning:

WARNING

Memory access

It must be ensured that the type and length of the container correspond to the size of the memory area at the pointer. Otherwise, this can lead to a system crash or invalid data.

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