L_VecGetGroupByName

#include "lvkrn.h"

L_LVKRN_API L_INT L_VecGetGroupByName(pVector, pszName, pGroup)

const pVECTORHANDLE pVector;

/* pointer to a vector handle */

const L_TCHAR * pszName;

/* group name */

pVECTORGROUP pGroup;

/* pointer to a vector group */

Gets the group with the specified name, in the specified vector handle.

Parameter

Description

pVector

Pointer to the vector handle.

pszName

Character string that contains the name of the group to get.

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

If two or more groups in a vector handle have the same name, this function will get the first group found.

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_VecGetGroupByIndex, L_VecGetGroup.

Topics:

Working with Vector Groups

Example

For an example, refer to L_VecDeleteGroup.