L_VecGetGroupByIndex

#include "ltvkrn.h"

L_LTVKRN_API L_INT L_VecGetGroupByIndex(pVector, nIndex, pGroup)

Gets the group at the specified index in the specified vector handle.

Parameters

const pVECTORHANDLE pVector

Pointer to the vector handle.

L_INT nIndex

Index of the requested group. This index is zero-based. Possible values are between 0 and L_VecGetGroupCount - 1.

pVECTORGROUP pGroup

Pointer to a VECTORGROUP structure to be updated with the group handle, if the group is found.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

To determine the number of groups in a vector handle, call L_VecGetGroupCount.

To get a group, given the name of the group, use L_VecGetGroupByName.

To get group information for a specific group, call L_VecGetGroup.

Required DLLs and Libraries

See Also

Functions

Topics

Example

For an example, refer to L_VecGetGroupCount.

Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Vector C API Help