messageBox Function

Syntax

value = messageBox(message, caption, flags);

Parameters

message

The text of the message box.

caption

The caption to display in the message box's title bar. If not specified, the name of your TQS application is used.

flags

A value composed of bit flags that control the buttons and icon displayed in the message box. Pass a number from the button flags table, optionally adding a number the icon flags table if desired.

Button flags:

0	OK button only (default)
1	OK and Cancel buttons
2	Abort, Retry, and Ignore buttons
3	Yes, No, and Cancel buttons
4	Yes and No buttons
5	Retry and Cancel buttons
6	Cancel, Try Again, and Continue buttons (Requires Windows 2000, XP, or newer)

Icon flags:

16	Error icon
32	Question mark icon
48	Exclamation icon
64	Information icon

Returns

Returns an value corresponding to the button in the message box that the user clicked:

Remarks

Use this function to display a custom message box to the user. The use of this function is preferred over the script functions alert and confirm.

Examples

The following displays a simple message box. Since no caption is specified, the TQS application's title will be used.

messageBox("That is correct!");

The following example asks the user a yes/no question. The value 36 represents 6 (Yes and No buttons) + 32 (Question mark icon). The code checks for the return value 6 to indicate whether Yes was pressed.

if(messageBox("Do you want to play again?",
  "Matching", 36) == 6)
{
  // play again
} else
{
  // do something else
}