L_VecEnumObjects
#include "lvkrn.h"
L_INT EXT_FUNCTION L_VecEnumObjects(pVector, pEnumProc, pUserData, dwFlags)
pVECTORHANDLE pVector; |
/* pointer to a vector handle */ |
pVECTORENUMOBJECTSPROC pEnumProc; |
/* pointer to a callback function */ |
/* pointer to more parameters for the callback */ | |
L_UINT32 dwFlags; |
/* flags */ |
Enumerates all objects inside a vector handle.
Parameter |
Description |
|
pVector |
Pointer to a vector handle. The objects within this vector handle will be enumerated. |
|
pEnumProc |
Pointer to the callback function used to enumerate the vertices within the vector handle. The callback function must adhere to the function prototype described in VECTORENUMOBJECTSPROC. |
|
pUserData |
Void pointer that you can use to pass one or more additional parameters that the callback function needs. |
|
|
o use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID L_FAR *. The callback function, which receives the address in its own pUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure. |
|
|
f the additional parameters are not needed, you can pass NULL in this parameter. |
|
dwFlags |
Flag that indicates which objects to enumerate. Possible values are: |
|
|
Value |
Meaning |
|
0 |
umerate all objects within the vector handle. |
|
VECTOR_FLAGS_SELECTED_ONLY |
Enumerate only the selected objects within the vector handle. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Note: |
n DirectX and OpenGL, you cannot enumerate objects, therefore this function will do nothing. |
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: |
Example
For an example, refer to L_VecIsObjectInsideRect.