1<?xml version="1.0" encoding="UTF-8"?>
2
3
4<!--***********************************************************************
5 *
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7 *
8 * Copyright 2000, 2010 Oracle and/or its affiliates.
9 *
10 * OpenOffice.org - a multi-platform office productivity suite
11 *
12 * This file is part of OpenOffice.org.
13 *
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
17 *
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
23 *
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org.  If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
28 *
29 ************************************************************************-->
30
31<helpdocument version="1.0">
32<meta>
33<topic id="textsbasicshared03010102xml" indexer="include" status="PUBLISH">
34<title id="tit" xml-lang="en-US">MsgBox Function [Runtime]</title>
35<filename>/text/sbasic/shared/03010102.xhp</filename>
36</topic>
37<history>
38<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
39<lastedited date="2005-09-13T11:33:09">converted from old format - fpe</lastedited>
40</history>
41</meta>
42<body>
43<section id="msgbox">
44<bookmark xml-lang="en-US" branch="index" id="bm_id3153379"><bookmark_value>MsgBox function</bookmark_value>
45</bookmark>
46<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>
47<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>
48</section>
49<paragraph role="heading" id="hd_id3156281" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
50<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>
51<paragraph role="heading" id="hd_id3153771" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
52<paragraph role="paragraph" id="par_id3146985" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph>
53<paragraph role="heading" id="hd_id3153363" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameter:</paragraph>
54<paragraph role="paragraph" id="par_id3153727" xml-lang="en-US" l10n="U" oldref="8">
55<emph>Text</emph>: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13).</paragraph>
56<paragraph role="paragraph" id="par_id3147317" xml-lang="en-US" l10n="U" oldref="9">
57<emph>DialogTitle</emph>: String expression displayed in the title bar of the dialog. If omitted, the name of the respective application is displayed.</paragraph>
58<paragraph role="paragraph" id="par_id3153954" xml-lang="en-US" l10n="U" oldref="10">
59<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>
60<paragraph role="paragraph" id="par_id3154319" xml-lang="en-US" l10n="U" oldref="11">
61<emph>Values</emph>
62</paragraph>
63<paragraph role="paragraph" id="par_id3147397" xml-lang="en-US" l10n="U" oldref="12">0 : Display OK button only.</paragraph>
64<paragraph role="paragraph" id="par_id3145646" xml-lang="en-US" l10n="U" oldref="13">1 : Display OK and Cancel buttons.</paragraph>
65<paragraph role="paragraph" id="par_id3149410" xml-lang="en-US" l10n="CHG" oldref="14">2 : Display Abort, Retry, and Ignore buttons.</paragraph>
66<paragraph role="paragraph" id="par_id3151075" xml-lang="en-US" l10n="U" oldref="15">3 : Display Yes, No, and Cancel buttons.</paragraph>
67<paragraph role="paragraph" id="par_id3153878" xml-lang="en-US" l10n="U" oldref="16">4 : Display Yes and No buttons.</paragraph>
68<paragraph role="paragraph" id="par_id3155601" xml-lang="en-US" l10n="U" oldref="17">5 : Display Retry and Cancel buttons.</paragraph>
69<paragraph role="paragraph" id="par_id3150716" xml-lang="en-US" l10n="U" oldref="18">16 : Add the Stop icon to the dialog.</paragraph>
70<paragraph role="paragraph" id="par_id3153837" xml-lang="en-US" l10n="U" oldref="19">32 : Add the Question icon to the dialog.</paragraph>
71<paragraph role="paragraph" id="par_id3150751" xml-lang="en-US" l10n="U" oldref="20">48 : Add the Exclamation Point icon to the dialog.</paragraph>
72<paragraph role="paragraph" id="par_id3146915" xml-lang="en-US" l10n="U" oldref="21">64 : Add the Information icon to the dialog.</paragraph>
73<paragraph role="paragraph" id="par_id3145640" xml-lang="en-US" l10n="U" oldref="22">128 : First button in the dialog as default button.</paragraph>
74<paragraph role="paragraph" id="par_id3153765" xml-lang="en-US" l10n="U" oldref="23">256 : Second button in the dialog as default button.</paragraph>
75<paragraph role="paragraph" id="par_id3153715" xml-lang="en-US" l10n="U" oldref="24">512 : Third button in the dialog as default button.</paragraph>
76<paragraph role="paragraph" id="par_id3159267" xml-lang="en-US" l10n="U" oldref="25">
77<emph>Return value:</emph>
78</paragraph>
79<paragraph role="paragraph" id="par_id3145230" xml-lang="en-US" l10n="U" oldref="26">1 : OK</paragraph>
80<paragraph role="paragraph" id="par_id3149567" xml-lang="en-US" l10n="U" oldref="27">2 : Cancel</paragraph>
81<paragraph role="paragraph" id="par_id4056825" xml-lang="en-US" l10n="NEW">3 : Abort</paragraph>
82<paragraph role="paragraph" id="par_id3155335" xml-lang="en-US" l10n="U" oldref="28">4 : Retry</paragraph>
83<paragraph role="paragraph" id="par_id3146918" xml-lang="en-US" l10n="U" oldref="29">5 : Ignore</paragraph>
84<paragraph role="paragraph" id="par_id3155961" xml-lang="en-US" l10n="U" oldref="30">6 : Yes</paragraph>
85<paragraph role="paragraph" id="par_id3148488" xml-lang="en-US" l10n="U" oldref="31">7 : No</paragraph>
86<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
87<embed href="text/sbasic/shared/00000003.xhp#err5"/>
88<paragraph role="heading" id="hd_id3150090" xml-lang="en-US" level="2" l10n="U" oldref="40">Example:</paragraph>
89<paragraph role="code" id="par_id3154120" xml-lang="en-US" l10n="U" oldref="41">Sub ExampleMsgBox</paragraph>
90<paragraph role="code" id="par_id3145131" xml-lang="en-US" l10n="U" oldref="42">Dim sVar as Integer</paragraph>
91<paragraph role="code" id="par_id3151278" xml-lang="en-US" l10n="U" oldref="43">sVar = MsgBox("Las Vegas")</paragraph>
92<paragraph role="code" id="par_id3149034" xml-lang="en-US" l10n="U" oldref="44">sVar = MsgBox("Las Vegas",1)</paragraph>
93<paragraph role="code" id="par_id3166424" xml-lang="en-US" l10n="U" oldref="45">sVar = MsgBox( "Las Vegas",256 + 16 + 2,"Dialog title")</paragraph>
94<paragraph role="code" id="par_id3152581" xml-lang="en-US" l10n="U" oldref="46">end sub</paragraph>
95</body>
96</helpdocument>
97