LAnnRTF::DeleteUserHandle

#include "ltwrappr.h"

virtual L_INT LAnnRTF::DeleteUserHandle(nIndex)

/* index of the user handle to delete */

Deletes an existing user-defined annotation handle. This function is available in the Document/Medical Toolkits.

Parameter	Description
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.

See Also

Functions:	Class Members
Topics:	Annotation Functions: Object Properties
	Implementing Annotations
	Automated User Interface for Annotations
	Annotation Functions: Creating and Deleting Annotations
	Types of Annotations
	Annotation Functions: Implementing Custom Annotations

Example

// This examples deletes the first user handle of an object
L_VOID ExampleAnnDeleteUserHandle(LAnnRTF *LRtf)
{
   L_UINT uCount;

   // Get the total count of user handles
   LRtf->GetUserHandles(NULL, &uCount);
   if (uCount > 0)
      LRtf->DeleteUserHandle(0);
   else
      MessageBox(NULL, TEXT("No User Handles!"), TEXT("Error"), MB_OK);
}