L_VecGetGroupByIndex

#include "lvkrn.h"

L_INT EXT_FUNCTION L_VecGetGroupByIndex(pVector, nIndex, pGroup)

const pVECTORHANDLE pVector;

/* Pointer to the vector handle */

L_INT nIndex;

/* Index */

pVECTORGROUP pGroup;

/* pointer to a vector group */

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

Parameter

Description

pVector

Pointer to the vector handle.

nIndex

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

pGroup

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

Returns

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

LVKRN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

L_VecGetGroupCount, L_VecGetGroupByName, L_VecGetGroup

Topics:

Working with Vector Groups

Example

For an example, refer to L_VecGetGroupCount.