1.2

Use for code0 when no code0 alerts are desired

Code0 - 0x80000000 (2147483648)

1.2

Called when a user-tool, started by VCSetUserTool, is initializing.

Code0 - 0x00000200 (512)

WM_CHAR - 0xFB (251)

void WINAPI YourAlertName_Init(WPARAM wParam, LPARAM lParam) Copy

Init(long wParam, long lParam)

wParam - 0xFB (251)
lParam - Tool ID

None

This alert will be followed by a ALERT_APP_TOOL_START when the tool starts.

1.2

Called when a user-tool, started by VCSetUserTool, is terminating.

Code0 - 0x00000400 (1024)

WM_CHAR - 0xFA (250)

void WINAPI YourAlertName_Terminate(WPARAM wParam, LPARAM lParam) Copy

Terminate(long wParam, long lParam)

wParam - 0xFA (250)
lParam - 0

None

1.2

Called when a user-tool, started by VCSetUserTool, is aborting.

Code0 - 0x00000004 (4)

WM_CHAR - 0x1B (27)

void WINAPI YourAlertName_Abort(WPARAM wParam, LPARAM lParam) Copy

Abort(long wParam, long lParam)

wParam - 0x1B (27)
lParam - 0

None

1.2

Called when a user-tool, started by VCSetUserTool, receives mouse-click input from the user.

Code0 - 0x00000001 (1)

WM_LBUTTONDOWN

void WINAPI YourAlertName_MouseDown(WPARAM wParam, LPARAM lParam) Copy

MouseDown(long wParam, long lParam)

wParam - 0
lParam - 0

None

Points entered by the user from the keyboard are translated into the equivalent mouse-click and sent as a mouse-down. Refer to API Help VCGetUserToolLBDown topic for mousedown location.

1.2

Called when a user-tool, started by VCSetUserTool, receives mousemove input from the user.

Code0 - 0x00000002 (2)

WM_MOUSEMOVE

void WINAPI YourAlertName_MouseMove(WPARAM wParam, LPARAM lParam) Copy

MouseMove(long wParam, long lParam)

wParam - 0
lParam - 0

None

Refer to API Help file for VCGetUserToolMouseMove for mousemove location.

2.0

Called when a user-tool, started by VCSetUserTool, receives mouseup input from the user.

Code0 - 0x00020000 (131072)

WM_LBUTTONUP

void WINAPI YourAlertName_MouseUp(WPARAM wParam, LPARAM lParam) Copy

MouseUp(long wParam, long lParam)

wParam - 0x0 (0)
lParam - 0

None

Refer to API Help file for VCGetUserToolLBUp for mouseup location.

1.2

Called when a user-tool, started by VCSetUserTool, receives a PenUp command from the user.

Code0 - 0x00000020 (32)

WM_CHAR - 0xFC (252)

void WINAPI YourAlertName_PenUp(WPARAM wParam, LPARAM lParam) Copy

PenUp(long wParam, long lParam)

wParam - 0xFC (252)
lParam - 0

None

1.2

Called when a user-tool, started by VCSetUserTool, needs to erase any possible rubberband from the screen.

Code0 - 0x00000080 (128)

WM_CHAR - 0xFF (255)

void WINAPI YourAlertName_EraseRubber(WPARAM wParam, LPARAM lParam) Copy

EraseRubber(long wParam, long lParam)

wParam - 0xFF (255)
lParam - 0

None

3.0

Called when a tool is starting.

Code0 - 0x02000000 (33554432)

WM_CHAR - 0xEC (236)

void WINAPI YourAlertName_ToolStart(WPARAM wParam, LPARAM lParam) Copy

ToolStart(long wParam, long lParam)

wParam - 0xEC (236)
lParam - LOWORD is tool ID, HIWORD is tool type

None

Tool types, Tool start sequence

1.2

Called when a tool is completing.

Code0 - 0x00000100 (256)

WM_CHAR - 0xFE (254)

void WINAPI YourAlertName_ToolComplete(WPARAM wParam, LPARAM lParam) Copy

ToolComplete(long wParam, long lParam)

wParam - 0xFE (254)
lParam - LOWORD is Tool ID, HIWORD is Tool Type

None

See ToolStart for discussion of when this alert is generated.

3.0

Called when a tool is aborting.

Code0 - 0x04000000 (67108864)

WM_CHAR - 0xEB (235)

void WINAPI YourAlertName_ToolAbort(WPARAM wParam, LPARAM lParam) Copy

ToolAbort(long wParam, long lParam)

wParam - 0xEB (235)
lParam - LOWORD is tool ID, HIWORD is tool type

None

Tool types, Tool start sequence

2.0.4

Called when the user mouse-clicks in the drawing.

Code0 - 0x00080000 (524288)

WM_CHAR - 0xF2 (242)

void WINAPI YourAlertName_WorldMouseDown(WPARAM wParam, LPARAM lParam) Copy

WorldMouseDown(long wParam, long lParam)

wParam - 0xF2 (242)
lParam - 0

None

This callback will receive all mousedowns, compared to the callback for user-tools which receives only mousedowns for that user-tool. Refer to API Help file for VCGetCurrentPoint for mousedown location.

2.0.4

Called when the user mouseups in the drawing.

Code0 - 0x00100000 (1048576)

WM_CHAR - 0xF1 (241)

void WINAPI YourAlertName_WorldMouseUp(WPARAM wParam, LPARAM lParam) Copy

WorldMouseUp(long wParam, long lParam)

wParam - 0xF1 (241)
lParam - 0

None

2.0.4

Called when the user mousemoves in the drawing.

Code0 - 0x00040000 (262144)

WM_CHAR - 0xF3 (243)

void WINAPI YourAlertName_WorldMouseMove(WPARAM wParam, LPARAM lParam) Copy

WorldMouseMove(long wParam, long lParam)

wParam - 0xF3 (243)
lParam - 0

None

Refer to API Help file for VCGetCurrentPoint for mousemove location.

1.2

Called when the user enters command line input from the keyboard.

Code0 - 0x00000008 (8)

WM_CHAR

void WINAPI YourAlertName_Char(WPARAM wParam, LPARAM lParam) Copy

Char(long wParam, long lParam)

wParam - ANSI character code
lParam - 0

None

Since the WM_CHAR message is also used for other alert messages, this alert should be used with caution if character values greater than 0X7F (127) may be encountered.

2.0

Called when an entity is erased.

Code0 - 0x00002000 (8192)

WM_CHAR - 0xF7 (247)

void WINAPI YourAlertName_EntityErased(WPARAM wParam, LPARAM lParam) Copy

EntityErased(long wParam, long lParam)

wParam - 0xF7 (247)
lParam - 0

None

2.0

Called when an entity's selection state changes.

Code0 - 0x00004000 (16384)

WM_CHAR - 0xF6 (246)

void WINAPI YourAlertName_EntitySelectChange(WPARAM wParam, LPARAM lParam) Copy

EntitySelectChange(long wParam, long lParam)

wParam - 0xF6 (246)
lParam - 0

None

2.0.4

Called when a drawing begins redrawing.

Code0 - 0x00400000 (4194304)

WM_CHAR - 0xEF (239)

void WINAPI YourAlertName_WorldBeginRedraw(WPARAM wParam, LPARAM lParam) Copy

WorldBeginRedraw(long wParam, long lParam)

wParam - 0xEF (239)
lParam - 0

None

2.0.4

Called when a drawing completes redrawing.

Code0 - 0x00200000 (2097152)

WM_CHAR - 0xF0 (240)

void WINAPI YourAlertName_WorldEndRedraw(WPARAM wParam, LPARAM lParam) Copy

WorldEndRedraw(long wParam, long lParam)

wParam - 0xF0 (240)
lParam - 0

None

2.0.4

Called when a drawing begins printing.

Code0 - 0x00800000 (8388608)

WM_CHAR - 0xEE (238)

void WINAPI YourAlertName_WorldBeginPrint(WPARAM wParam, LPARAM lParam) Copy

WorldBeginPrint(long wParam, long lParam)

wParam - 0xEE (238)
lParam - 0

None

2.0.4

Called when a drawing completes printing.

Code0 - 0x01000000 (16777216)

WM_CHAR - 0xED (237)

void WINAPI YourAlertName_WorldEndPrint(WPARAM wParam, LPARAM lParam) Copy

WorldEndPrint(long wParam, long lParam)

wParam - 0xED (237)
lParam - 0

None

3.0

Called when a dialog has opened.

Code1 - 0x00000010 (16)

WM_CHAR - 0xE5 (229)

void WINAPI YourAlertName_DialogOpen(WPARAM wParam, LPARAM lParam) Copy

DialogOpen(long wParam, long lParam)

wParam - 0xE5 (229)
lParam - Dialog ID

None

This message is posted with PostMessage

3.0

Called when a dialog has closed.

Code1 - 0x00000020 (32)

WM_CHAR - 0xE4 (228)

void WINAPI YourAlertName_DialogClose(WPARAM wParam, LPARAM lParam) Copy

DialogClose(long wParam, long lParam)

wParam - 0xE4 (228)
lParam - Dialog ID

None

This message is posted with PostMessage

1.2

Called when the VCADD application is closing.

Code0 - 0x00000010 (16)

WM_CLOSE

void WINAPI YourAlertName_AppClose(WPARAM wParam, LPARAM lParam) Copy

AppClose(long wParam, long lParam)

wParam - 0x0 (0)
lParam - 0

None

This is equivalent to ALERT_APP_FRAME_CLOSE

1.2

Called when a VCADD drawing is closing.

Code0 - 0x00000040 (64)

WM_CHAR - 0xFD (253)

void WINAPI YourAlertName_DrawingClose(WPARAM wParam, LPARAM lParam) Copy

DrawingClose(long wParam, long lParam)

wParam - 0xFD (253)
lParam - 0

None

2.0

Called when the main VCADD frame window is closing.

Code0 - 0x00000800 (2048)

WM_CHAR - 0xF9 (249)

void WINAPI YourAlertName_FrameClose(WPARAM wParam, LPARAM lParam) Copy

FrameClose(long wParam, long lParam)

wParam - 0xF9 (249)
lParam - 0

None

This is equivalent to ALERT_APP_CLOSE

2.0

Called when the main VCADD frame window is resizing.

Code0 - 0x00001000 (4096)

WM_CHAR - 0xF8 (248)

void WINAPI YourAlertName_FrameResize(WPARAM wParam, LPARAM lParam) Copy

FrameResize(long wParam, long lParam)

wParam - 0xF8 (248)
lParam - 0

None

2.0

Called when the VCADD application is being activated.

Code0 - 0x00008000 (32768)

WM_CHAR - 0xF5 (245)

void WINAPI YourAlertName_Activate(WPARAM wParam, LPARAM lParam) Copy

Activate(long wParam, long lParam)

wParam - 0xF5 (245)
lParam - 0

None

2.0

Called when the VCADD application is being deactivated.

Code0 - 0x00010000 (65536)

WM_CHAR - 0xF4 (244)

void WINAPI YourAlertName_DeActivate(WPARAM wParam, LPARAM lParam) Copy

DeActivate(long wParam, long lParam)

wParam - 0xF4 (244)
lParam - 0

None

5.0

Called just after a world is activated.

Code1 - 0x00000080 (128)

WM_CHAR - 0xE2 (226)

void WINAPI YourAlertName_WorldActivate(WPARAM wParam, LPARAM lParam) Copy

WorldActivate(long wParam, long lParam)

wParam - 0xE2 (226)
lParam - HWND of the world just activated

None

5.0

Called just before a world is deactivated

Code1 - 0x00000100 (256)

WM_CHAR - 0xE1 (225)

void WINAPI YourAlertName_WorldDeActivate(WPARAM wParam, LPARAM lParam) Copy

WorldDeActivate(long wParam, long lParam)

wParam - 0xE1 (225)
lParam - HWND of the world to be deactivated

None

5.0

Called when a file is being opened

Code1 - 0x00000200 (512)

WM_CHAR - 0xE0 (224)

void WINAPI YourAlertName_FileOpen(WPARAM wParam, LPARAM lParam) Copy

FileOpen(long wParam, long lParam)

wParam - 0xE0 (224)
lParam - Flag indicating the file's opening state

None

See the API help file or VCtypes32.h for flag values

5.0

Called when a file is being saved

Code1 - 0x00000400 (1024)

WM_CHAR - 0xDF (223)

void WINAPI YourAlertName_FileSave(WPARAM wParam, LPARAM lParam) Copy

FileSave(long wParam, long lParam)

wParam - 0xDF (223)
lParam - Flag indicating the file's saving state

None

See the API help file or VCtypes32.h for flag values

3.0

Called when VCADD receives a user alert sent by the user's application

Code1 - 0x00000008 (8)

WM_CHAR - 0xE6 (230)

void WINAPI YourAlertName_UserAlert(WPARAM wParam, LPARAM lParam) Copy

UserAlert(long wParam, long lParam)

wParam - 0xE6 (230)
lParam - The LParam value included with the posted VCM_USER_ALERT message.

None

This is analogous to WM_USER messages and allows the user to send and process user-defined messages.
User posts a user alert to VCADD with the following:
PostMessage((HWND)VCGethWndFrame(), WM_COMMAND, VCM_USER_ALERT, lParam);
Note: VCM_USER_ALERT is defined as 2801 in VCTypes32.h This message is posted with PostMessage.

3.0

Called when VCADD gets a PostMessage message from the Windows message queue.

Code1 - 0x00000001 (1)

Pass thru

BOOL WINAPI YourAlertName_PreTranslateGetMessage(AlertMSG* pMsg) Copy

PreTranslateGetMessage(long* hWnd, long* uMsg, long* wParam, long* lParam, long* Reserved, long* lResult, long* lResultFlag) As Integer

pMsg - pointer to message structure, separate member parameters for event

Return TRUE to prevent VCADD from processing the message.

3.0

Called when VCADD handles a Windows SendMessage.

Code1 - 0x00000002 (2)

Pass thru

BOOL WINAPI YourAlertName_PreTranslateFrameMessage(AlertMSG* pMsg) Copy

PreTranslateFrameMessage(long* hWnd, long* uMsg, long* wParam, long* lParam, long* Reserved, long* lResult, long* lResultFlag) As Integer

pMsg - pointer to message structure, separate member parameters for event

Return TRUE to prevent VCADD from processing the message.

To have VCADD return a specific value for the message, set lResult to the desired value and lResultFlag to TRUE, otherwise VCADD will return TRUE.

3.0

Called when VCADD processes dialog box messages.

Code1 - 0x00000004 (4)

Pass thru

BOOL WINAPI YourAlertName_PreTranslateDialogMessage(AlertMSG* pMsg) Copy

PreTranslateDialogMessage(long* hWnd, long* uMsg, long* wParam, long* lParam, long* Reserved, long* lResult, long* lResultFlag) As Integer

pMsg - pointer to message structure, separate member parameters for event

Return TRUE to prevent VCADD from processing the message.

To have VCADD return a specific value for the message, set lResult to the desired value and lResultFlag to TRUE, otherwise VCADD will return TRUE.

4.0

Called when VCADD processes MDI child messages.

Code1 - 0x00000040 (64)

Pass thru

BOOL WINAPI YourAlertName_PreTranslateMdiChildMessage(AlertMSG* pMsg) Copy

PreTranslateMdiChildMessage(long* hWnd, long* uMsg, long* wParam, long* lParam, long* Reserved, long* lResult, long* lResultFlag) As Integer

pMsg - pointer to message structure, separate member parameters for event

Return TRUE to prevent VCADD from processing the message.

To have VCADD return a specific value for the message, set lResult to the desired value and lResultFlag to TRUE, otherwise VCADD will return TRUE.

9.0.1

Called when a VCADD file dialog handles events.

Code1 - 0x00000800 (2048)

WM_COPYDATA

BOOL WINAPI YourAlertName_FileDialog(AlertMSG* pMsg) Copy

FileDialog(long* hWnd, long* uMsg, long* wParam, long* lParam, long* Reserved, long* lResult, long* lResultFlag) As Integer

pMsg - pointer to message structure, separate member parameters for event

Return 0 to ignore the event. See specific events below for other values.

The lParam member of the pMSG structure points to a COPYDATASTRUCT where the lower BYTE of the dwData member is an event code and the lpData member is a pointer to a string with the information related to the event. The hWnd parameter is the window handle of the file dialog.
For the ActiveX/COM Event, the lParam is a BSTR.