In This Topic ▼

L_AutGetCurrentTool

Summary

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

Syntax

#include "ltaut.h"

L_LTAUT_API L_INT L_AutGetCurrentTool(pAutomation, pnTool)

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

LTAUT
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

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; 
}