VECTORENUMGROUPSPROC Function

#include "lvkrn.h"

L_INT pEXT_CALLBACK YourFunction(pVector, pGroup, pUserData)

pVECTORHANDLE pVector;

/* pointer to a vector handle */

pVECTORGROUP pGroup;

/* pointer to a vector group */

L_VOID *pUserData;

/* pointer to additional parameters */

Processes each vector group enumerated by the L_VecEnumGroups function.

Parameter

Description

pVector

Pointer to the vector handle that contains the groups to enumerate.

pGroup

Pointer to the vector group being processed.

pUserData

A void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of the calling function.)

 

Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The L_VecEnumGroups function calls the callback function as it gets the handle of each vector group.

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_VecEnumGroups

Topics:

Working with Vector Groups

Example

For an example, refer to L_VecEnumGroups.