LAnnAudioClip::EnumHandleCallBack

#include "ltwrappr.h"

virtual L_INT LAnnAudioClip::EnumHandleCallBack(hObject, pHandleInfo)

Processes each annotation object from the LAnnAudioClip::EnumerateHandles function.

Parameters

HANNOBJECT hObject

Handle of the annotation object being processed.

pANNHANDLEINFO pHandleInfo

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

Returns

Value Meaning
SUCCESS_CHANGE [1] Change the object
SUCCESS_NOCHANGE [2] Do not change the object

Comments

The LAnnAudioClip::EnumerateHandles 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:

To change the location of a user-defined node, use LAnnAudioClip::ChangeUserHandle.

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.

To enable the LAnnAudioClip::EnumHandleCallBack you must call LBase::EnableCallBack before calling LAnnAudioClip::EnumerateHandles function.

For more information, refer to the documentation for ANNHANDLEINFO.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to LAnnAudioClip::EnumerateHandles.

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

LEADTOOLS Raster Imaging C++ Class Library Help