ANNENUMHANDLECALLBACK (original) (raw)

Summary

Processes each annotation object from the L_AnnEnumerateHandles function.

Syntax

#include "l_bitmap.h"

L_INT pEXT_CALLBACK YourFunction(hObject, pHandleInfo, pUserData)

Parameters

HANNOBJECT hObject

Handle of the annotation object being processed.

pANNHANDLEINFO pHandleInfo

Pointer to structure that contains information about the annotation object handle.

L_VOID *pUserData

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 L_AnnEnumerateHandles function. Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

Comments

The L_AnnEnumerateHandles function calls your callback function for each handle of a single annotation object.

The pHandleInfo structure can be used to obtain detailed information about an annotation object handle. It can also be used to change some (but not all) of the properties of a user handle. All properties of an annotation object handle can be changed EXCEPT the location. The properties of a node that can be changed with this function are:

• ID
• Visibility
• Pen color
• Fill color
• Shape
• Cursor

To change the location of a user-defined node, use L_AnnChangeUserHandle.

To change the properties of an annotation object handle, set the corresponding field in the pHandleInfo structure, and return SUCCESS_CHANGED. To leave the handle properties unchanged, return SUCCESS_UNCHANGED.

For more information, refer to the documentation for ANNHANDLEINFO.

Required DLLs and Libraries

• LTANN
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

Example

For an example, refer to L_AnnEnumerateHandles.