F_VN_ExportSubContainer_String
Export the container elements of a sub-container into a string. Only possible for 2-dimensional containers of type ContainerType_Vector_String_SINT.
Syntax
Definition:
FUNCTION F_VN_ExportSubContainer_String : HRESULT
VAR_INPUT
ipContainer : ITcVnContainer;
nIndex : ULINT;
sText : STRING;
nMaxLength : ULINT;
hrPrev : HRESULT;
END_VAR
Inputs
|
Name |
Type |
Description |
|---|---|---|
|
ipContainer |
Container of type ContainerType_Vector_String_SINT | |
|
nIndex |
ULINT |
Index of the requested element |
|
sText |
STRING |
Make sure to choose a sufficient STRING size! The required size can be determined using the function VnExportSubContainerSize. |
|
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 indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.) |
Return valueApplication
The function F_VN_ExportSubContainer is used, for example, to obtain the result text in the case of Code Reading:
hr := F_VN_ReadPharmaCode(ipImage, ipDecodedText, hr);
IF hr = S_OK THEN
hr := F_VN_ExportSubContainer_String(ipDecodedText, 0, sCodeAsString, 255, hr);
// sCodeAsString contains the result
END_IF
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 |