UserMessage event

Description

Fires when a User Message task occurs.

Syntax

 

HRESULT UserMessage( [in] LONG session, [in] BSTR caption, [in] BSTR message, [in] VARIANT_BOOL wantsData, [out] BSTR* userData );

Parameters

 

session	[in] The session ID.
caption	[in] The title bar text.
message	[in] The message (body) text.
wantsData	[in] A value that indicates whether data can be returned in the userData parameter to update a JavaScript variable specified in the User Message task. Possible values: TRUE = Data can be returned FALSE = Data cannot be returned
userData	[out] Pointer to a variable that receives the variable value. The value of the wantsData parameter must be TRUE. The data returned is used to set the JavaScript variable specified in the User Message task.