F_VN_ExportContainer_String

F_VN_ExportContainer_String 1:

Export the container elements into a string. Only possible for containers of type ContainerType_String_SINT.

Syntax

Definition:

FUNCTION F_VN_ExportContainer_String : HRESULT
VAR_INPUT
    ipContainer : ITcVnContainer;
    sText       : STRING;
    nMaxLength  : ULINT;
    hrPrev      : HRESULT;
END_VAR

F_VN_ExportContainer_String 2: Inputs

Name

Type

Description

ipContainer

ITcVnContainer

Container of type ContainerType_String_SINT

sText

STRING

Make sure to choose a sufficient STRING size! The required size can be determined using the function VnExportContainerSize.

nMaxLength

ULINT

Maximum string length to export (including 0 termination). If the container content is longer, the string is cut off at nMaxLength - 1 and 0 termination is appended. In this case, S_FALSE is returned.

hrPrev

HRESULT

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

F_VN_ExportContainer_String 3: Return value

HRESULT

Related functions

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