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:

HRESULT ExportSubContainer_String(
    HRESULT         hrPrev,
    ITcVnContainer* ipContainer,
    ULONGLONG       nIndex,
    PCHAR           sText,
    ULONGLONG       nMaxLength
)

Parameters

Name

Type

Description

hrPrev

HRESULT

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

ipContainer

ITcVnContainer*

Container of type ContainerType_Vector_String_SINT

nIndex

ULONGLONG

Index of the requested element

sText

PCHAR

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

nMaxLength

ULONGLONG

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.

ExportSubContainer_String 1: Return value

HRESULT

Required License

TC3 Vision Base

System Requirements