L_VecEnumObjects

Summary

Enumerates all objects inside a vector handle.

Syntax

#include "ltvkrn.h"

L_LVKRN_API L_INT L_VecEnumObjects(pVector, pEnumProc, pUserData, dwFlags)

Parameters

pVECTORHANDLE pVector

Pointer to a vector handle. The objects within this vector handle will be enumerated.

pVECTORENUMOBJECTSPROC 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.

L_VOID * 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 *. 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.

L_UINT32 dwFlags

Flag that indicates which objects to enumerate. Possible values are:

Value Meaning
0 Enumerate all objects within the vector handle.
VECTOR_FLAGS_SELECTED_ONLY Enumerate only the selected objects within the vector handle.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

Required DLLs and Libraries

See Also

Functions

Example

For an example, refer to L_VecIsObjectInsideRect.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Vector C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.