LAnnRedact::EnumerateHandles

#include "ltwrappr.h"

virtual L_INT LAnnRedact::EnumerateHandles()

Calls the LAnnRedact::EnumHandleCallBack function for ALL handles (both default and user-defined) for an annotation object. This function is available in the Document/Medical Toolkits.

Returns

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

Comments

Use this function to get information about all annotation handles for an annotation object.

Note that this function returns information about both default annotation handles and user-defined annotation handles.

This function can also be used to change some of the properties of an annotation handle.

For more information, refer to the LAnnRedact::EnumHandleCallBack function.

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.

See Also

Functions:	Class Members
Topics:	Annotation Functions: Creating and Deleting Annotations
	Implementing Annotations
	Annotation Functions: Implementing Custom Annotations

Example

class MyAnnRedact: public LAnnRedact
{
public:
   virtual L_INT EnumHandleCallBack(HANNOBJECT hObject, pANNHANDLEINFO pHandleInfo);
};

L_INT MyAnnRedact::EnumHandleCallBack(HANNOBJECT hObject, pANNHANDLEINFO pHandleInfo)
{
   pHandleInfo->bVisible = TRUE;
   if (pHandleInfo->nType == ANNHANDLETYPE_DEFAULT_HANDLE)
   {
      pHandleInfo->nShape = ANNHANDLE_SHAPE_SQUARE;
      pHandleInfo->crFill = RGB(0,0,255);
   }
   else
   {
      pHandleInfo->nShape = ANNHANDLE_SHAPE_CIRCLE;
      pHandleInfo->crFill = RGB(0,255,0);
   }
   return SUCCESS_CHANGE;
}

L_VOID ExampleAnnEnumerateHandles(MyAnnRedact *LRedact)
{
   LRedact->EnableCallBack(TRUE);
   LRedact->EnumerateHandles();
}