L_AnnDeleteUserHandle

Summary

Deletes an existing user-defined annotation handle.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnDeleteUserHandle(hObject, nIndex)

Parameters

HANNOBJECT hObject

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

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 an annotation object.

Set nIndex to -1 to delete all the user-defined handles for annotation object hObject.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

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) 
   { 
      _tprintf(_T("%s"), TEXT("Error: No User Handles!")); 
      return FAILURE; 
   } 
    
   return L_AnnDeleteUserHandle(hObject, 0); 
}

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

LEADTOOLS Raster Imaging C API Help
Introduction
Version History
Getting Started
Files To Be Included With Your Application
Document Writers – Files To Be Included With Your Application
LEADTOOLS Raster Imaging Features
Quick Reference
Tutorials
Function References
Callback Functions
Summary of Features
Appendix
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.