SortContainer

Sort container elements.

Syntax

Definition:

FUNCTION SortContainer: HRESULT
VAR_INPUT
ipContainer:    ITcVnContainer;
nSortByElemIdx: UINT;
eComparisonOp:  ETcVnComparisonOperator
hrPrev:         HRESULT
END_VAR

SortContainer 1: Inputs

Name

Type

Description

ipContainer

ITcVnContainer

Container to sort (only basic arithmetic, TcVnPoint and TcVnVector containers are supported).

nSortByElemIdx

UINT

Index of the element data to sort by (0 for arithmetic types, 0 or 1 for TcVnPoint2 and TcVnVector2, 0 to 2 for TcVnPoint3 and TcVnVector3, 0 to 3 for TcVnVector4.

eComparisonOp

ETcVnComparisonOperator

Element comparison operator (LESS to sort ascending or GREATER to sort descending).

hrPrev

HRESULT

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

SortContainer 2: Return Value

HRESULT

Required License

TC3 Vision Base

System Requirements