In This Topic ▼

LAnnRTF::ChangeUserHandle

Summary

Changes properties of an existing user-defined annotation handle.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnRTF::ChangeUserHandle(nIndex, pAnnHandle)

Parameters

L_INT32 nIndex

Index of the user handle to change. This index is zero-based.

pANNHANDLE pAnnHandle

Pointer to a structure that defines how to change the user handle.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Use this function to change the properties of an existing user-defined annotation handle.

This function is used in conjunction with:

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.

Example

This example changes the first user handle of an object by

Moving handle ten pixels to the left
Changing color of handle to blue
Changing shape of handle to square

Displays the hour glass cursor when mouse over the handle

L_INT LAnnRTF_ChangeUserHandleExample(LAnnRTF *LRtf)  
{ 
	L_INT nRet; 
   L_UINT uCount;  
   ANNHANDLE AnnHandle;  
 
   // Get the total count of user handles 
   nRet = LRtf->GetUserHandles(NULL, &uCount);  
	if(nRet != SUCCESS) 
		return nRet; 
   if (uCount > 0)  
   { 
      memset(&AnnHandle, 0, sizeof(ANNHANDLE));  
      AnnHandle.uStructSize = sizeof(&AnnHandle);  
      nRet = LRtf->GetUserHandle(0, &AnnHandle);  
		if(nRet != SUCCESS) 
			return nRet; 
       
      AnnHandle.aptContainer.x +=10;  
      AnnHandle.crFill = RGB(0,0,255);  
      AnnHandle.nShape = ANNHANDLE_SHAPE_SQUARE;  
      AnnHandle.hCursor = LoadCursor(NULL,IDC_APPSTARTING);  
      AnnHandle.uFlags = ANNHANDLE_FILL_COLOR | ANNHANDLE_SHAPE | ANNHANDLE_LOCATION | ANNHANDLE_CONTAINER_COORDINATES;  
      nRet = LRtf->ChangeUserHandle(0, &AnnHandle);  
		if(nRet != SUCCESS) 
			return nRet; 
   } 
   else 
	{ 
      MessageBox(NULL, TEXT("No User Handles!"), TEXT("Error"), MB_OK);  
		return FAILURE; 
	} 
	return SUCCESS; 
}