In This Topic ▼

L_AnnGetToolBarChecked

Summary

Gets the selected tool in the annotation toolbar.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetToolBarChecked(hwndToolBar, puChecked)

Parameters

HWND hwndToolBar

Window handle for the toolbar. You get the window handle when you create the toolbar using the L_AnnCreateToolBar function.

L_UINT *puChecked

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

Value	Meaning
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 puChecked 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.

Example

For a complete sample code, refer to the \Examples\Annotation\C\Annotate demo.
This example gets the toolbar window’s current tool and assigns it to a global variable.

L_INT AnnGetToolBarCheckedExample(L_HWND ToolbarWnd /* Window for the annotation toolbar */, 
   L_UINT CurrentAutoTool /* Annotation tool in automation mode */) 
{ 
   L_INT nRet; 
   L_TCHAR szMessage[80]; 
 
   nRet = L_AnnGetToolBarChecked(ToolbarWnd, &CurrentAutoTool); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   wsprintf(szMessage, TEXT("Notice: Tool number %d"), CurrentAutoTool); 
   _tprintf(_T("%s"), szMessage); 
 
   return SUCCESS; 
}