VCGetUserToolState

Version:

2.0

Description:

Determines the current user tool state.

Declaration:

C/C++

extern "C" short WINAPI VCGetUserToolState(short* iError);
extern "C" void WINAPI VCSetUserToolState(short* iError, short iNewState);

Delphi

function VCGetUserToolState(var iError: Smallint):Smallint; stdcall;
procedure VCSetUserToolState(var iError: Smallint; iNewState: Smallint); stdcall;

ActiveX/COM

Function GetUserToolState() As Integer
Sub SetUserToolState(ByVal i As Integer)

Parameters:

iNewState - the new state for the tool.

Notes:

User tools are represented in by varying input level states. This level is set when creating the tool with VCSetUserTool. The states correspond to the number input points or stops the tools makes during operation. The API allows an application to overwrite the current state in order to repeat an operation.