VCButton


Version:

1.2, Obsolete in 5.0 - See Notes.

Description:

Send a mouse button click message to Visual CADD™.

Declaration:

 

C/C++

extern "C" void WINAPI VCButton(short iButton, short iState);

Delphi

procedure VCButton(iButton: Smallint; iState: Smallint); stdcall;

ActiveX/COM

Sub Button(ByVal iButton As Integer, ByVal iState As Integer)

Parameters:

iState - represents the up or down state, where 0 denotes and 1 denotes down.
iButton
- the specific button number on the puck starting with 0 and ending with 15 to represent a 16 button digitizer puck.

Notes:

This is analogous to the user pressing a button on the pointing device within Visual CADD™. Depending on what script assignments have been made to each button, different events may occur. Keep in mind that button 1 (number 0) and the right button (number 1 or 2 depending on the mouse) have special meanings within Visual CADD™ and will be interpreted as such. These of course also depend on the cursor location in the drawing and the current, if any, active commands.

Due to longstanding bugs, VCButton has not operated as documented through several versions of Visual CADD™.  In particular, iState was unused, the button numbers were 1-16 and not 0-15, and the button numbers were different when Visual CADD™ was in tablet mode.  It was determined that VCButton could not be reliably fixed without considerable risk of breaking existing applications which might be using it.  Therefore, VCButton is obsolete effective with v5.0 and has been replaced by VCRunFunkeyCmd and VCRunFunkeyCmdByName which offer all the functionality of VCButton plus additional features.  VCButton will remain in the API to support existing applications which use it, but VCButton should be considered obsolete for future use.  It is recommended that all future code use VCRunFunkeyCmd or VCRunFunkeyCmdByName instead.

See Also:

VCRunFunkeyCmd, VCRunFunkeyCmdByName