LAnnRuler::DeleteUserHandle

#include "ltwrappr.h"

virtual L_INT LAnnRuler::DeleteUserHandle(nIndex)

L_INT32 nIndex;

index of the user handle to delete

Deletes an existing user-defined annotation handle.

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 nIndex to -1 to delete all the user-defined handles for the annotation object.

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:

Class Members, LAnnRuler::AddUserHandle, LAnnRuler::EnumerateHandles, LAnnRuler::EnumHandleCallBack, LAnnRuler::GetUserHandle, LAnnRuler::GetUserHandles, LAnnRuler::ChangeUserHandle

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_INT LAnnRuler_DeleteUserHandleExample(LAnnRuler *LRuler)  
{ 
	L_INT nRet; 
   L_UINT uCount;  
 
   // Get the total count of user handles 
   nRet = LRuler->GetUserHandles(NULL, &uCount);  
	if(nRet != SUCCESS) 
		return nRet; 
   if (uCount > 0)  
	{ 
      nRet = LRuler->DeleteUserHandle(0);  
		if(nRet != SUCCESS) 
			return nRet; 
	} 
   else 
	{ 
      MessageBox(NULL, TEXT("No User Handles!"), TEXT("Error"), MB_OK);  
		return FAILURE; 
	} 
	return SUCCESS; 
}

Help Version 20.0.2020.4.5
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 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
Tutorials
Classes and Member Functions
Summary of Features