LAnnTextPointer::DeleteUserHandle (original) (raw)
Summary
Deletes an existing user-defined annotation handle.
Syntax
#include "ltwrappr.h"
virtual L_INT LAnnTextPointer::DeleteUserHandle(nIndex)
Parameters
L_INT32 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
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
Comments
Call this function to delete a user-defined handle from the annotation object.
Set nIndex to -1 to delete all the user-defined handles.
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
Win32, x64.
See Also
Functions
- LAnnTextPointer::AddUserHandle
- LAnnTextPointer::EnumerateHandles
- LAnnTextPointer::EnumHandleCallBack
- LAnnTextPointer::GetUserHandle
- LAnnTextPointer::GetUserHandles
- LAnnTextPointer::ChangeUserHandle
- 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
- Fixed Annotations
- Minimizing Flicker With Double Buffering
Example
// This examples deletes the first user handle of an object
L_INT LAnnTextPointer_DeleteUserHandleExample(LAnnTextPointer *LTextPointer)
{
L_INT nRet;
L_UINT uCount;
// Get the total count of user handles
nRet = LTextPointer->GetUserHandles(NULL, &uCount);
if(nRet != SUCCESS)
return nRet;
if (uCount > 0)
{
nRet = LTextPointer->DeleteUserHandle(0);
if(nRet != SUCCESS)
return nRet;
}
else
{
MessageBox(NULL, TEXT("No User Handles!"), TEXT("Error"), MB_OK);
return FAILURE;
}
return SUCCESS;
}
LEADTOOLS Raster Imaging C++ Class Library Help