|
<< Click to Display Table of Contents >> Navigation: Miscellaneous functions and statements > MsgBox |
Description
Displays a message in a dialog box, waits for the user to click a button, and returns a value indicating which button the user clicked.
Syntax
Result = MsgBox(prompt[, buttons][, title])
or
MsgBox prompt, buttons][, title]
Parameters
Part |
Type |
Description |
prompt |
String |
String expression displayed as the message in the dialog box. The maximum length of prompt is approximately 1024 characters, depending on the width of the characters used. If prompt consists of more than one line, you can separate the lines using a carriage return character (Chr(13)), a linefeed character (Chr(10)), or carriage return–linefeed character combination (Chr(13) & Chr(10)) between each line. You can even use the system defined constants like vbCR, vbLf, vbCrLf… |
buttons |
Integer |
Optional. Numeric expression that is the sum of values specifying the number and type of buttons to display, the icon style to use, the identity of the default button, and the modality of the message box. See Settings section for values. If omitted, the default value for buttons is 0. |
title |
String |
String expression displayed in the title bar of the dialog box. If you omit title, the application name is placed in the title bar. |
MsgBox Constants
The following constants are used with the MsgBox function to identify what buttons and icons appear on a message box and which button is the default. In addition, the modality of the MsgBox can be specified. Since these constants are built into Quick3270 Scripting language, you don't have to define them before using them. Use them anywhere in your code to represent the values shown for each.
Constant |
Value |
Description |
|---|---|---|
vbOKOnly |
0 |
Display OK button only. |
vbOKCancel |
1 |
Display OK and Cancel buttons. |
vbAbortRetryIgnore |
2 |
Display Abort, Retry, and Ignore buttons. |
vbYesNoCancel |
3 |
Display Yes, No, and Cancel buttons. |
vbYesNo |
4 |
Display Yes and No buttons. |
vbRetryCancel |
5 |
Display Retry and Cancel buttons. |
vbCritical |
16 |
Display Critical Message icon. |
vbQuestion |
32 |
Display Warning Query icon. |
vbExclamation |
48 |
Display Warning Message icon. |
vbInformation |
64 |
Display Information Message icon. |
vbDefaultButton1 |
0 |
First button is the default. |
vbDefaultButton2 |
256 |
Second button is the default. |
vbDefaultButton3 |
512 |
Third button is the default. |
vbDefaultButton4 |
768 |
Fourth button is the default. |
vbApplicationModal |
0 |
Application modal. The user must respond to the message box before continuing work in the current application. |
vbSystemModal |
4096 |
System modal. This constant provides an application modal message box that always remains on top of any other programs you may have running. |
vbMsgBoxHelpButton |
16384 |
Adds Help button to the message box |
vbMsgBoxSetForeground |
65536 |
Specifies the message box window as the foreground window |
vbMsgBoxRight |
524288 |
Text is right aligned |
vbMsgBoxRtlReading |
1048576 |
Specifies text should appear as right-to-left reading on Hebrew and Arabic systems |
MsgBox Return Values.
The following constants are used with the MsgBox function to identify which button a user has selected. These constants are built into Quick3270 Scripting language; you don't have to define them before using them.
Constant |
Value |
Description |
vbOK |
1 |
OK button was clicked. |
vbCancel |
2 |
Cancel button was clicked. |
vbAbort |
3 |
Abort button was clicked. |
vbRetry |
4 |
Retry button was clicked. |
vbIgnore |
5 |
Ignore button was clicked. |
vbYes |
6 |
Yes button was clicked. |
vbNo |
7 |
No button was clicked. |