VCGetUserToolSnapPoint

Version:

9.0.0

Description:

Sets the snap point to return to the previous tool for user tools which are snaps.

Declaration:

C/C++

extern "C" void WINAPI VCGetUserToolSnapPoint(short* iError, Point2D* dpP);
extern "C" void WINAPI VCSetUserToolSnapPoint(short* iError, Point2D* dpP);

Delphi

procedure VCGetUserToolSnapPoint(var iError: SmallInt; var dpP: Point2D); stdcall;
procedure VCSetUserToolSnapPoint(var iError: SmallInt; var dpP: Point2D); stdcall;

ActiveX/COM

Function GetUserToolSnapPoint() As IVCPoint2D
Sub SetUserToolSnapPoint(dpP As IVCPoint2D)

Parameters:

dpP - the snap point

Return Value:

iError Code:

0 - Success
1 - Invalid world

Notes:

If the user tool is a snap, then VCSetUserToolSnapPoint is used to set the snap point before the user tool completes and returns control to the previous tool.