L_AnnGetTool

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetTool(hObject, puTool)

HANNOBJECT hObject;

handle to the annotation automation object

L_UINT *puTool;

address of the variable to be updated

Gets the default tool, which is maintained by the automation object.

Parameter Description
hObject Handle to the annotation automation object.
puTool Address of the variable to be updated with the value of the constant for the selected tool. Possible values are:
  Value Meaning
  ANNTOOL_SELECT [0] Selection pointer
  ANNTOOL_LINE [1] Line
  ANNTOOL_RECT [2] Rectangle
  ANNTOOL_ELLIPSE [3] Ellipse
  ANNTOOL_POLYLINE [4] Polyline
  ANNTOOL_POLYGON [5] Polygon
  ANNTOOL_POINTER [6] Pointer
  ANNTOOL_FREEHAND [7] Freehand line
  ANNTOOL_HILITE [8] Highlight
  ANNTOOL_REDACT [9] Redaction
  ANNTOOL_TEXT [10] Text
  ANNTOOL_NOTE [11] Note
  ANNTOOL_STAMP [12] Stamp
  ANNTOOL_BUTTON [13] Button
  ANNTOOL_HOTSPOT [14] HotSpot
  ANNTOOL_AUDIO [15] Audio clip
  ANNTOOL_RULER [16] Ruler clip
  ANNTOOL_CROSSPRODUCT [17] Cross product
  ANNTOOL_POINT [18] Point
  ANNTOOL_PROTRACTOR [19] Protractor
  ANNTOOL_VIDEO [20] Video
  ANNTOOL_PUSHPIN [21] Pushpin
  ANNTOOL_FREEHANDHOTSPOT [22] Freehand HotSpot
  ANNTOOL_STAMP_FIRST [29] First rubber stamp
  ANNTOOL_STAMP_APPROVED [29] Approved rubber stamp
  ANNTOOL_STAMP_ASSIGNED [30] Assigned rubber stamp
  ANNTOOL_STAMP_CHECKED [31] Checked rubber stamp
  ANNTOOL_STAMP_CLATPRV [32] Client Attorney Privilege rubber stamp
  ANNTOOL_STAMP_COPY [33] Copy rubber stamp
  ANNTOOL_STAMP_DRAFT [34] Draft rubber stamp
  ANNTOOL_STAMP_EXTENDED [35] Extended rubber stamp
  ANNTOOL_STAMP_FAX [36] Fax rubber stamp
  ANNTOOL_STAMP_FAXED [37] Faxed rubber stamp
  ANNTOOL_STAMP_IMPORTANT [38] Important rubber stamp
  ANNTOOL_STAMP_INVOICE [39] Invoice rubber stamp
  ANNTOOL_STAMP_NOTICE [40] Notice rubber stamp
  ANNTOOL_STAMP_OFFICIAL [41] Official rubber stamp
  ANNTOOL_STAMP_ONFILE [42] Onfile rubber stamp
  ANNTOOL_STAMP_PAID [43] Paid rubber stamp
  ANNTOOL_STAMP_PASSED [44] Passed rubber stamp
  ANNTOOL_STAMP_PENDING [45] Pending rubber stamp
  ANNTOOL_STAMP_PROCESSED [46] Processed rubber stamp
  ANNTOOL_STAMP_RECEIVED [47] Received rubber stamp
  ANNTOOL_STAMP_REJECTED [48] Rejected rubber stamp
  ANNTOOL_STAMP_RELEASE [49] Release rubber stamp
  ANNTOOL_STAMP_SENT [50] Sent rubber stamp
  ANNTOOL_STAMP_SHIPPED [51] Shipped rubber stamp
  ANNTOOL_STAMP_TOPSECRET [52] Top Secret rubber stamp
  ANNTOOL_STAMP_URGENT [53] Urgent rubber stamp
  ANNTOOL_STAMP_VOID [54] Void rubber stamp
  ANNTOOL_STAMP_LAST [55] the last rubber stamp
  ANNTOOL_LAST [56] the last tool button
  ANNTOOL_USER [0x0100] the first user defined tool
  ANNTOOL_USERLAST [0x0200] the last allowed user defined tool

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Before calling this function, you must declare a variable of data type L_UINT. Then, pass the address of the variable in the puTool parameter. This function will update the variable with the value of the constant for the selected tool.

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:

L_AnnCreate, L_AnnSetAutoContainer,

 

L_AnnGetAutoContainer, L_AnnSetDpiX, L_AnnSetDpiY, L_AnnGetDpiX, L_AnnGetDpiY, L_AnnSetTool, L_AnnGetUserMode, L_AnnSetUserMode, L_AnnSetUndoDepth, L_AnnUndo

Topics:

Annotation Functions: Working with the Toolbar

 

Implementing Annotations

 

Automated User Inteface for Annotations

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Using Rulers in Annotation Objects

 

Annotation Features

 

Calibrating Annotation Ruler Objects

Example

This example gets the automation object’s current tool and assigns it to a global variable.

L_INT AnnGetToolExample(HANNOBJECT hAutoObject,      /* Automation object */ 
                                        L_UINT*    puCurrentAutoTool)/* Annotation tool in automation mode */ 
{ 
   L_INT nRet; 
   nRet = L_AnnGetTool(hAutoObject, puCurrentAutoTool); 
   if(nRet != SUCCESS) 
      return nRet; 
   return SUCCESS; 
} 

Help Version 20.0.2018.2.25
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help