LAnnButton::DeleteUserHandle

Summary

Deletes an existing user-defined annotation handle.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnButton::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 an annotation object.

Set nIndex to -1 to delete all the user-defined handles.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

//This examples deletes the first user handle of an object 

L_INT LAnnButton_DeleteUserHandleExample(LAnnButton *LButton)  
{ 
   L_INT nRet; 
 
   L_UINT uCount;  
  
   // Get the total count of user handles 
 
   nRet = LButton->GetUserHandles(NULL, &uCount);  
   if(nRet != SUCCESS) 
      return nRet; 
  
   if (uCount > 0)  
   { 
      nRet = LButton->DeleteUserHandle(0);  
      if(nRet != SUCCESS) 
         return nRet; 
   } 
   else 
   { 
      MessageBox(NULL,TEXT("No User Handles!"), TEXT("Error"), MB_OK);  
      return FAILURE; 
   } 
 
   return SUCCESS; 
}

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++ Class Library Help
Introduction
Version History
Getting Started
LEADTOOLS Raster Imaging Features
Redistributables/Files To Be Included With Your Application
Quick Reference
Classes and Member Functions
Summary of Features
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.