Displays a message in a dialog box, waits for the user to click a button, and returns an Integer indicating which button the user clicked.
MsgBox(prompt [, buttons ] [, title ] [, helpfile ] [, context ] )
The MsgBox function syntax has these arguments (argument: A value that provides information to an action, an event, a method, a property, a function, or a procedure.):
||Required. String expression (string expression: An expression that evaluates to a sequence of contiguous characters. Elements of the expression can be: functions that return a string or a string Variant (VarType 8); a string literal, constant, variable, or Variant.) 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.
||Optional. numeric expression (numeric expression: Any expression that evaluates to a number. The expression can be any combination of variables, constants, functions, and operators.) 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. If omitted, the default value for buttons is 0.
||Optional. String expression displayed in the title bar of the dialog box. If you omit title, the application name is placed in the title bar.
||Optional. String expression that identifies the Help file to use to provide context-sensitive Help for the dialog box. If helpfile is provided, context must also be provided.
||Optional. Numeric expression that is the Help context number assigned to the appropriate Help topic by the Help author. If context is provided, helpfile must also be provided.
The buttons argument (argument: A value that provides information to an action, an event, a method, a property, a function, or a procedure.) settings are:
||Display OK button only.
||Display OK and Cancel buttons.
||Display Abort, Retry, and Ignore buttons.
||Display Yes, No, and Cancel buttons.
||Display Yes and No buttons.
||Display Retry and Cancel buttons.
||Display Critical Message icon.
||Display Warning Query icon.
||Display Warning Message icon.
||Display Information Message icon.
||First button is default.
||Second button is default.
||Third button is default.
||Fourth button is default.
||Application modal; the user must respond to the message box before continuing work in the current application.
||System modal; all applications are suspended until the user responds to the message box.
||Adds Help button to the message box
||Specifies the message box window as the foreground window
||Text is right aligned
||Specifies text should appear as right-to-left reading on Hebrew and Arabic systems
Tip In Access 2010, the Expression Builder has IntelliSense, so you can see what arguments your expression requires.
Watch a video or try Office 2010.
The first group of values (0–5) describes the number and type of buttons displayed in the dialog box; the second group (16, 32, 48, 64) describes the icon style; the third group (0, 256, 512) determines which button is the default; and the fourth group (0, 4096) determines the modality of the message box. When adding numbers to create a final value for the buttons argument, use only one number from each group.
Note These constants (constant: A value that is not calculated and, therefore, does not change. For example, the number 210, and the text "Quarterly Earnings" are constants. An expression, or a value resulting from an expression, is not a constant.) are specified by Visual Basic for Applications. As a result, the names can be used anywhere in your code in place of the actual values.
When both helpfile and context are provided, the user can press F1 (Windows) or HELP (Macintosh) to view the Help topic corresponding to the context. Some host applications (host application: Any application that supports the use of Visual Basic for Applications.), for example, Microsoft Office Excel 2007, also automatically add a Help button to the dialog box.
If the dialog box displays a Cancel button, pressing the ESC key has the same effect as clicking Cancel. If the dialog box contains a Help button, context-sensitive Help is provided for the dialog box. However, no value is returned until one of the other buttons is clicked.
Note To specify more than the first named argument, you must use MsgBox in an expression (expression: Any combination of mathematical or logical operators, constants, functions, and names of fields, controls, and properties that evaluates to a single value. Expressions can perform calculations, manipulate characters, or test data.). To omit some positional arguments (argument: A value that provides information to an action, an event, a method, a property, a function, or a procedure.), you must include the corresponding comma delimiter.
Note Examples that follow demonstrate the use of this function in a Visual Basic for Applications (VBA) module. For more information about working with VBA, select Developer Reference in the drop-down list next to Search and enter one or more terms in the search box.
This example uses the MsgBox function to display a critical-error message in a dialog box with Yes and No buttons. The No button is specified as the default response. The value returned by the MsgBox function depends on the button chosen by the user. This example assumes that
DEMO.HLP is a Help file that contains a topic with a Help context number equal to
Dim Msg, Style, Title, Help, Ctxt, Response, MyString
Msg = "Do you want to continue?"
Style = vbYesNo + vbCritical + vbDefaultButton2
Title = "MsgBox Demonstration"
Help = "DEMO.HLP"
Ctxt = 1000
Response = MsgBox(Msg, Style, Title, Help, Ctxt)
If Response = vbYes Then ' User chose Yes.
MyString = "Yes" ' Perform some action.
Else ' User chose No.
MyString = "No" ' Perform some action.