VCGetUserToolFlags

Version:

9.0.0

Description:

Sets the current user tool flags.

Declaration:

C/C++

extern "C" DWORD WINAPI VCGetUserToolFlags(short* iError);
extern "C" void WINAPI VCSetUserToolFlags(short* iError, DWORD dw);

Delphi

function VCGetUserToolFlags(var iError: SmallInt): LongWord; stdcall;
procedure VCSetUserToolFlags(var iError: SmallInt; dw: LongWord); stdcall;

ActiveX/COM

Function GetUserToolFlags() As Long
Sub SetUserToolFlags(ByVal dw As Long)

Parameters:

dw - see VCSetUserToolEx for the flags and their usage

Return Value:

$RETURN$

iError Code:

0 - Success
1 - Invalid world

Notes:

The user tool flags control the behavior of the user tool after it was created by VCSetUserTool or VCSetUserToolEx. Because some user tool behavior only applies to nested user tools, those behaviors require that the user tool must have been created with VCSetUserToolEx by using the USERTOOL_IS_NESTED flag in order to set those user tool flags. Once the USERTOOL_IS_NESTED flag has been set or not set by VCSetUserTool or VCSetUserToolEx, the USERTOOL_IS_NESTED flag cannot later be changed by VCSetUserToolFlags. The USERTOOL_IS_NESTED flag is fixed for the duration of the user tool.