L_AnnDeleteUserHandle

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnDeleteUserHandle(hObject, nIndex)

HANNOBJECT hObject;

/* handle to the annotation object */

L_INT32 nIndex;

/* index of the user handle to delete */

Deletes an existing user-defined annotation handle.

This function is available in the Document and Medical Imaging toolkits.

Parameter

Description

hObject

Handle to the annotation object from which to delete the user handle.

nIndex

Index of the user-defined handle to delete. The index is zero based. Pass -1 to delete all user-defined handles. Passing a negative value other than 1 makes the function return ERROR_INV_PARAMETER.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Call this function to delete a user-defined handle from an annotation object.

Set uIndex to -1 to delete all the user-defined handles for annotation object hObject;

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.

Platforms

Windows 2000 / XP/Vista.

See Also

Functions:

L_AnnDefine, L_AnnAddUserHandle, L_AnnAdjustPoint, L_AnnChangeUserHandle, L_AnnConvert, L_AnnDefine2, L_AnnEnumerateHandles, L_AnnGetRestrictToContainer, L_AnnGetRotateAngle, L_AnnGetUserHandle, L_AnnGetUserHandles, L_AnnHitTest, L_AnnRestrictCursor, L_AnnSetRestrictToContainer

Topics:

Annotation Functions: Creating and Deleting Annotations

 

Implementing Custom Annotations

 

Implementing Annotations

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Types of Annotations

 

Annotation Objects - Default Values

Example

This examples deletes the first user handle of an object. 

 L_INT AnnDeleteUserHandleExample(HANNOBJECT hObject)
{
   L_INT nRet;
   L_UINT uCount;

   // Get the total count of user handles
   nRet = L_AnnGetUserHandles(hObject, NULL, &uCount);
   if(nRet != SUCCESS)
      return nRet;
   if (uCount > 0)
   {
      L_AnnDeleteUserHandle(hObject, 0);
   }
   else
   {
      MessageBox(NULL, TEXT("No User Handles!"), TEXT("Error"), MB_OK);
      return 0;
   }
   return SUCCESS;
}