1<?xml version="1.0" encoding="UTF-8"?>
2
3<!--***********************************************************
4 *
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements.  See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership.  The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License.  You may obtain a copy of the License at
12 *
13 *   http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied.  See the License for the
19 * specific language governing permissions and limitations
20 * under the License.
21 *
22 ***********************************************************-->
23
24<helpdocument version="1.0">
25<meta>
26<topic id="textsbasicshared03010102xml" indexer="include" status="PUBLISH">
27<title id="tit" xml-lang="en-US">MsgBox Function [Runtime]</title>
28<filename>/text/sbasic/shared/03010102.xhp</filename>
29</topic>
30</meta>
31<body>
32<section id="msgbox">
33<bookmark xml-lang="en-US" branch="index" id="bm_id3153379"><bookmark_value>MsgBox function</bookmark_value>
34</bookmark>
35<paragraph role="heading" id="hd_id3153379" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03010102.xhp" name="MsgBox Function [Runtime]">MsgBox Function [Runtime]</link></paragraph>
36<paragraph role="paragraph" id="par_id3145171" xml-lang="en-US" l10n="U" oldref="2">Displays a dialog box containing a message and returns a value.</paragraph>
37</section>
38<paragraph role="heading" id="hd_id3156281" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
39<paragraph role="code" id="par_id3154685" xml-lang="en-US" l10n="U" oldref="4">MsgBox (Text As String [,Type As Integer [,Dialogtitle As String]])</paragraph>
40<paragraph role="heading" id="hd_id3153771" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
41<paragraph role="paragraph" id="par_id3146985" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph>
42<paragraph role="heading" id="hd_id3153363" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameter:</paragraph>
43<paragraph role="paragraph" id="par_id3153727" xml-lang="en-US" l10n="U" oldref="8">
44<emph>Text</emph>: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13).</paragraph>
45<paragraph role="paragraph" id="par_id3147317" xml-lang="en-US" l10n="U" oldref="9">
46<emph>DialogTitle</emph>: String expression displayed in the title bar of the dialog. If omitted, the name of the respective application is displayed.</paragraph>
47<paragraph role="paragraph" id="par_id3153954" xml-lang="en-US" l10n="U" oldref="10">
48<emph>Type</emph>: Any integer expression that specifies the dialog type and defines the number and type of buttons or icons displayed. <emph>Type</emph> represents a combination of bit patterns (dialog elements defined by adding the respective values):</paragraph>
49<paragraph role="paragraph" id="par_id3154319" xml-lang="en-US" l10n="U" oldref="11">
50<emph>Values</emph>
51</paragraph>
52<paragraph role="paragraph" id="par_id3147397" xml-lang="en-US" l10n="U" oldref="12">0 : Display OK button only.</paragraph>
53<paragraph role="paragraph" id="par_id3145646" xml-lang="en-US" l10n="U" oldref="13">1 : Display OK and Cancel buttons.</paragraph>
54<paragraph role="paragraph" id="par_id3149410" xml-lang="en-US" l10n="CHG" oldref="14">2 : Display Abort, Retry, and Ignore buttons.</paragraph>
55<paragraph role="paragraph" id="par_id3151075" xml-lang="en-US" l10n="U" oldref="15">3 : Display Yes, No, and Cancel buttons.</paragraph>
56<paragraph role="paragraph" id="par_id3153878" xml-lang="en-US" l10n="U" oldref="16">4 : Display Yes and No buttons.</paragraph>
57<paragraph role="paragraph" id="par_id3155601" xml-lang="en-US" l10n="U" oldref="17">5 : Display Retry and Cancel buttons.</paragraph>
58<paragraph role="paragraph" id="par_id3150716" xml-lang="en-US" l10n="U" oldref="18">16 : Add the Stop icon to the dialog.</paragraph>
59<paragraph role="paragraph" id="par_id3153837" xml-lang="en-US" l10n="U" oldref="19">32 : Add the Question icon to the dialog.</paragraph>
60<paragraph role="paragraph" id="par_id3150751" xml-lang="en-US" l10n="U" oldref="20">48 : Add the Exclamation Point icon to the dialog.</paragraph>
61<paragraph role="paragraph" id="par_id3146915" xml-lang="en-US" l10n="U" oldref="21">64 : Add the Information icon to the dialog.</paragraph>
62<paragraph role="paragraph" id="par_id3145640" xml-lang="en-US" l10n="U" oldref="22">128 : First button in the dialog as default button.</paragraph>
63<paragraph role="paragraph" id="par_id3153765" xml-lang="en-US" l10n="U" oldref="23">256 : Second button in the dialog as default button.</paragraph>
64<paragraph role="paragraph" id="par_id3153715" xml-lang="en-US" l10n="U" oldref="24">512 : Third button in the dialog as default button.</paragraph>
65<paragraph role="paragraph" id="par_id3159267" xml-lang="en-US" l10n="U" oldref="25">
66<emph>Return value:</emph>
67</paragraph>
68<paragraph role="paragraph" id="par_id3145230" xml-lang="en-US" l10n="U" oldref="26">1 : OK</paragraph>
69<paragraph role="paragraph" id="par_id3149567" xml-lang="en-US" l10n="U" oldref="27">2 : Cancel</paragraph>
70<paragraph role="paragraph" id="par_id4056825" xml-lang="en-US" l10n="NEW">3 : Abort</paragraph>
71<paragraph role="paragraph" id="par_id3155335" xml-lang="en-US" l10n="U" oldref="28">4 : Retry</paragraph>
72<paragraph role="paragraph" id="par_id3146918" xml-lang="en-US" l10n="U" oldref="29">5 : Ignore</paragraph>
73<paragraph role="paragraph" id="par_id3155961" xml-lang="en-US" l10n="U" oldref="30">6 : Yes</paragraph>
74<paragraph role="paragraph" id="par_id3148488" xml-lang="en-US" l10n="U" oldref="31">7 : No</paragraph>
75<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
76<embed href="text/sbasic/shared/00000003.xhp#err5"/>
77<paragraph role="heading" id="hd_id3150090" xml-lang="en-US" level="2" l10n="U" oldref="40">Example:</paragraph>
78<paragraph role="code" id="par_id3154120" xml-lang="en-US" l10n="U" oldref="41">Sub ExampleMsgBox</paragraph>
79<paragraph role="code" id="par_id3145131" xml-lang="en-US" l10n="U" oldref="42">Dim sVar as Integer</paragraph>
80<paragraph role="code" id="par_id3151278" xml-lang="en-US" l10n="U" oldref="43">sVar = MsgBox("Las Vegas")</paragraph>
81<paragraph role="code" id="par_id3149034" xml-lang="en-US" l10n="U" oldref="44">sVar = MsgBox("Las Vegas",1)</paragraph>
82<paragraph role="code" id="par_id3166424" xml-lang="en-US" l10n="U" oldref="45">sVar = MsgBox( "Las Vegas",256 + 16 + 2,"Dialog title")</paragraph>
83<paragraph role="code" id="par_id3152581" xml-lang="en-US" l10n="U" oldref="46">end sub</paragraph>
84</body>
85</helpdocument>
86