VCSetUserTool


Version:

1.2

Description:

Creates a new user defined tool and its first prompt.

Declaration:

 

C/C++

extern "C" void WINAPI VCSetUserTool(short iStates, char* szNativeCmd, char* szFirstPrompt);

Delphi

procedure VCSetUserTool(iStates: Smallint; szNativeCmd: PAnsiChar; szFirstPrompt PAnsiChar); stdcall;

ActiveX/COM

Sub SetUserTool(ByVal iStates As Integer, ByVal szNativeCmd As String, ByVal szFirstPrompt As String)

Parameters:

iStates - number of steps the tool uses (-1 specifies a continuous tool that ends with Esc or a pen-up)
szNativeCmd
- name of a custom native command as defined in a CmdExt.vcdef file
szFirstPrompt
- string used as the first prompt for the tool

Notes:

Developing a user tool requires that the tool be defined in a CmdExt.vcdef file found either in the Visual CADD™ system folder or in a subfolder of the Addons folder. The format for the CmdExt.vcdef file can be found in the Customizing Visual CADD section of the main Visual CADD™ help.

For tools designed for v9.0.0 and later, VCSetUserToolEx provides more control over the tool.

See Also:

VCSetUserToolEx, VCGetUserToolLBDown, VCGetUserToolMouseMove, VCSetPrompt, VCSetUserToolSnapable, VCSetAlertApp, VCClearAlertApp