L_AutGetCurrentTool

#include "ltaut.h"

L_LTAUT_API L_INT L_AutGetCurrentTool(pAutomation, pnTool)

Manually sets the current tool in an automation handle without using the toolbar.

Parameters

pAUTOMATIONHANDLE pAutomation

Pointer to an automation handle.

L_INT *pnTool

Pointer to a variable to be updated with the current tool ID. For more information about tools, tool identifiers and toolbar buttons, refer to the Toolbar C API help.

Returns

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

Comments

This function lets you simulate a toolbar, instead of using the one provided by LEAD Automation.

Required DLLs and Libraries

See Also

Functions

Topics

Example

This example will determine if the current tool in a vector automation handle is the line tool.

L_BOOL AutGetCurrentToolExample(pAUTOMATIONHANDLE pAutomation, L_INT  *nRet) 
{ 
   /* Assume pAutomation is a valid vector automation handle, and no toolbar has been set */ 
   L_INT nTool; 
 
   *nRet = L_AutGetCurrentTool( pAutomation, &nTool ); 
 
   if( nTool == ID_TOOL_VECTOR_LINE ) 
      return TRUE; 
   else 
      return FALSE; 
} 

Help Version 21.0.2020.8.24
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Container and Automation C API Help