VCGetUserToolIsSnap

Version:

9.0.0

Description:

Sets the current user tool to be a snap.

Declaration:

C/C++

extern "C" vbool WINAPI VCGetUserToolIsSnap(short* iError);
extern "C" void WINAPI VCSetUserToolIsSnap(short* iError, vbool tf);

Delphi

function VCGetUserToolIsSnap(var iError: SmallInt): WordBool; stdcall;
procedure VCSetUserToolIsSnap(var iError: SmallInt; tf: WordBool); stdcall;

ActiveX/COM

Function GetUserToolIsSnap() As Integer
Sub SetUserToolIsSnap(ByVal tf As Integer)

Parameters:

tf - user tool is a snap or not
0 (FALSE) - sets the current user tool to not be a snap
1 (TRUE) - sets the current user tool to be a snap

Return Value:

user tool is a snap or not
0 (FALSE) - the current user tool is not a snap
1 (TRUE) - the current user tool is a snap

iError Code:

0 - Success
1 - Invalid world

Notes:

Snaps are nested tools which send a point to the previous tool when they are done. Because the user tool must be nested, the user tool must have been created with VCSetUserToolEx by using the USERTOOL_IS_NESTED flag in order to set it as a snap.