Revision as of 09:03, 9 February 2007

Declaration

MsgBox(message ; buttons:optional scalar ; title:optional text)

Description

MsgBox displays a standard popup modal dialog with a user-supplied message when it is evaluated. Evaluation ceases until the user presses a button on the message box.

The optional <buttons> parameter can be used to control which buttons are displayed, as follows:

0 = OK only
1 = OK and Cancel
2 = Abort, Retry and Ignore
3 = Yes, No and Cancel
4 = Yes and No
5 = Retry and Cancel

The icon can also be changed by adding the following to the buttons parameter:

16 = Critical
32 = Question
48 = Exclamation
64 = Information

The return value indicates which button was pressed, as follows:

1 = OK
2 = Cancel
3 = Abort
4 = Retry
5 = Ignore
6 = Yes
7 = No

In ADE, MsgBox displays nothing and returns 0.

@@ Line 1: / Line 1: @@
 [[category:User-interface functions]]
-Displays specified text in a message box dialog and waits for the user to press a button.
+= Declaration =
-{{stub}}
+ MsgBox(message ; buttons:optional scalar ; title:optional text)
+= Description =
+MsgBox displays a standard popup modal dialog with a user-supplied message when it is evaluated.  Evaluation ceases until the user presses a button on the message box.
+The optional <buttons> parameter can be used to control which buttons are displayed, as follows:
+* 0 = OK only
+* 1 = OK and Cancel
+* 2 = Abort, Retry and Ignore
+* 3 = Yes, No and Cancel
+* 4 = Yes and No
+* 5 = Retry and Cancel
+The icon can also be changed by adding the following to the buttons parameter:
+* 16 = Critical
+* 32 = Question
+* 48 = Exclamation
+* 64 = Information
+The return value indicates which button was pressed, as follows:
+* 1 = OK
+* 2 = Cancel
+* 3 = Abort
+* 4 = Retry
+* 5 = Ignore
+* 6 = Yes
+* 7 = No
+In ADE, MsgBox displays nothing and returns 0.

Difference between revisions of "MsgBox"

Revision as of 09:03, 9 February 2007

Declaration

Description