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