L_VecGetGroup
#include "lvkrn.h"
L_LVKRN_API L_INT L_VecGetGroup(pVector, pGroup, pGroupDesc)
const pVECTORHANDLE pVector; |
/* pointer to a vector handle */ |
const pVECTORGROUP pGroup; |
/* pointer to a vector group */ |
pVECTORGROUPDESC pGroupDesc; |
/* pointer to a structure */ |
Gets group information for the specified group.
Parameter |
Description |
pVector |
Pointer to the vector handle. |
pGroup |
Pointer to a VECTORGROUP structure that references the requested group. |
pGroupDesc |
Pointer to a VECTORGROUPDESC structure to be updated with the group information if the group is found. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
When pGroupDesc is no longer needed, L_VecFreeGroup should be called to free any resources associated with the VECTORGROUPDESC structure.
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_VecAddGroup, L_VecFreeGroup, L_VecGetGroupByIndex, L_VecGetGroupByName, L_VecGetGroupCount |
Topics: |
Example
For an example, refer to L_VecCopyGroup.