summaryrefslogtreecommitdiff
path: root/helpcontent2/source/text/sbasic/shared/03010102.xhp
blob: e5037dee7812ef69019d75cc5797680cc79d3dea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<?xml version="1.0" encoding="UTF-8"?>
<!--***********************************************************************
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRUNTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRUNTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc..
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************--><helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03010102xml" indexer="include" status="PUBLISH">
<title xml-lang="en-US" id="tit">MsgBox Function [Runtime]</title>
<filename>/text/sbasic/shared/03010102.xhp</filename>
</topic>
<history>
<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
<lastedited date="2003-10-31T00:00:00">converted from old format - fpe</lastedited>
</history>
</meta>
<body>
  
  
  <section id="msgbox">
  <bookmark xml-lang="en-US" branch="index" id="bm_id3153379"><bookmark_value>MsgBox;function</bookmark_value></bookmark><paragraph id="hd_id3153379" role="heading" level="1" oldref="1" l10n="U" xml-lang="en-US"><link href="text/sbasic/shared/03010102.xhp" name="MsgBox Function [Runtime]">MsgBox Function [Runtime]</link></paragraph>
  <paragraph role="paragraph" id="par_id3145171" l10n="U" xml-lang="en-US" oldref="2">Displays a dialog box containing a message and returns a value.</paragraph>
  </section>
  <paragraph role="heading" level="2" id="hd_id3156281" l10n="U" xml-lang="en-US" oldref="3">Syntax:</paragraph>
  <paragraph role="paragraph" id="par_id3154685" l10n="U" xml-lang="en-US" oldref="4">MsgBox (Text As String [,Type As Integer [,Dialogtitle As String]])</paragraph>
  <paragraph role="heading" level="2" id="hd_id3153771" l10n="U" xml-lang="en-US" oldref="5">Return value:</paragraph>
  <paragraph role="paragraph" id="par_id3146985" l10n="U" xml-lang="en-US" oldref="6">Integer</paragraph>
  <paragraph role="heading" level="2" id="hd_id3153363" l10n="U" xml-lang="en-US" oldref="7">Parameter:</paragraph>
  <paragraph l10n="U" role="paragraph" id="par_id3153727" xml-lang="en-US" oldref="8"><emph>Text</emph>: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13).</paragraph>
  <paragraph l10n="U" role="paragraph" id="par_id3147317" xml-lang="en-US" oldref="9"><emph>DialogTitle</emph>: String expression displayed in the title bar of the dialog. If omitted, the name of the respective application is displayed.</paragraph>
  <paragraph l10n="U" xml-lang="en-US" role="paragraph" id="par_id3153954" oldref="10"><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>
  <paragraph l10n="U" role="paragraph" id="par_id3154319" xml-lang="en-US" oldref="11"><emph>Values</emph></paragraph>
  <paragraph role="paragraph" id="par_id3147397" l10n="U" xml-lang="en-US" oldref="12">0 : Display OK button only.</paragraph>
  <paragraph role="paragraph" id="par_id3145646" l10n="U" xml-lang="en-US" oldref="13">1 : Display OK and Cancel buttons.</paragraph>
  <paragraph role="paragraph" id="par_id3149410" l10n="U" xml-lang="en-US" oldref="14">2 : Display Cancel and Retry buttons.</paragraph>
  <paragraph role="paragraph" id="par_id3151075" l10n="U" xml-lang="en-US" oldref="15">3 : Display Yes, No, and Cancel buttons.</paragraph>
  <paragraph role="paragraph" id="par_id3153878" l10n="U" xml-lang="en-US" oldref="16">4 : Display Yes and No buttons.</paragraph>
  <paragraph role="paragraph" id="par_id3155601" l10n="U" xml-lang="en-US" oldref="17">5 : Display Retry and Cancel buttons.</paragraph>
  <paragraph role="paragraph" id="par_id3150716" l10n="U" xml-lang="en-US" oldref="18">16 : Add the Stop icon to the dialog.</paragraph>
  <paragraph role="paragraph" id="par_id3153837" l10n="U" xml-lang="en-US" oldref="19">32 : Add the Question icon to the dialog.</paragraph>
  <paragraph role="paragraph" id="par_id3150751" l10n="U" xml-lang="en-US" oldref="20">48 : Add the Exclamation Point icon to the dialog.</paragraph>
  <paragraph role="paragraph" id="par_id3146915" l10n="U" xml-lang="en-US" oldref="21">64 : Add the Information icon to the dialog.</paragraph>
  <paragraph role="paragraph" id="par_id3145640" l10n="U" xml-lang="en-US" oldref="22">128 : First button in the dialog as default button.</paragraph>
  <paragraph role="paragraph" id="par_id3153765" l10n="U" xml-lang="en-US" oldref="23">256 : Second button in the dialog as default button.</paragraph>
  <paragraph role="paragraph" id="par_id3153715" l10n="U" xml-lang="en-US" oldref="24">512 : Third button in the dialog as default button.</paragraph>
  <paragraph l10n="U" role="paragraph" id="par_id3159267" xml-lang="en-US" oldref="25"><emph>Return value:</emph></paragraph>
  <paragraph role="paragraph" id="par_id3145230" l10n="U" xml-lang="en-US" oldref="26">1 : OK</paragraph>
  <paragraph role="paragraph" id="par_id3149567" l10n="U" xml-lang="en-US" oldref="27">2 : Cancel</paragraph>
  <paragraph role="paragraph" id="par_id3155335" l10n="U" xml-lang="en-US" oldref="28">4 : Retry</paragraph>
  <paragraph role="paragraph" id="par_id3146918" l10n="U" xml-lang="en-US" oldref="29">5 : Ignore</paragraph>
  <paragraph role="paragraph" id="par_id3155961" l10n="U" xml-lang="en-US" oldref="30">6 : Yes</paragraph>
  <paragraph role="paragraph" id="par_id3148488" l10n="U" xml-lang="en-US" oldref="31">7 : No</paragraph>
  <embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
  <embed href="text/sbasic/shared/00000003.xhp#err5"/>
  <paragraph role="heading" level="2" id="hd_id3150090" l10n="U" xml-lang="en-US" oldref="40">Example:</paragraph>
  <paragraph role="paragraph" id="par_id3154120" l10n="U" xml-lang="en-US" oldref="41">Sub ExampleMsgBox</paragraph>
  <paragraph role="paragraph" id="par_id3145131" l10n="U" xml-lang="en-US" oldref="42">Dim sVar as Integer</paragraph>
  <paragraph role="paragraph" id="par_id3151278" l10n="U" xml-lang="en-US" oldref="43">sVar = MsgBox(&quot;Las Vegas&quot;)</paragraph>
  <paragraph role="paragraph" id="par_id3149034" l10n="U" xml-lang="en-US" oldref="44">sVar = MsgBox(&quot;Las Vegas&quot;,1)</paragraph>
  <paragraph role="paragraph" id="par_id3166424" l10n="U" xml-lang="en-US" oldref="45">sVar = MsgBox( &quot;Las Vegas&quot;,256 + 16 + 2,&quot;Dialog title&quot;)</paragraph>
  <paragraph role="paragraph" id="par_id3152581" l10n="U" xml-lang="en-US" oldref="46">end sub</paragraph>
 </body>
</helpdocument>