1<?xml version="1.0" encoding="UTF-8"?>
2
3
4<!--***********************************************************
5 *
6 * Licensed to the Apache Software Foundation (ASF) under one
7 * or more contributor license agreements.  See the NOTICE file
8 * distributed with this work for additional information
9 * regarding copyright ownership.  The ASF licenses this file
10 * to you under the Apache License, Version 2.0 (the
11 * "License"); you may not use this file except in compliance
12 * with the License.  You may obtain a copy of the License at
13 *
14 *   http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing,
17 * software distributed under the License is distributed on an
18 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19 * KIND, either express or implied.  See the License for the
20 * specific language governing permissions and limitations
21 * under the License.
22 *
23 ***********************************************************-->
24
25
26
27<helpdocument version="1.0">
28<meta>
29<topic id="textsbasicshared03090402xml" indexer="include" status="PUBLISH">
30<title id="tit" xml-lang="en-US">Choose Function [Runtime]</title>
31<filename>/text/sbasic/shared/03090402.xhp</filename>
32</topic>
33<history>
34<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
35<lastedited date="2004-08-24T09:37:38">converted from old format - fpe</lastedited>
36</history>
37</meta>
38<body>
39<section id="choose">
40<bookmark xml-lang="en-US" branch="index" id="bm_id3143271"><bookmark_value>Choose function</bookmark_value>
41</bookmark>
42<paragraph role="heading" id="hd_id3143271" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03090402.xhp" name="Choose Function [Runtime]">Choose Function [Runtime]</link></paragraph>
43<paragraph role="paragraph" id="par_id3149234" xml-lang="en-US" l10n="U" oldref="2">Returns a selected value from a list of arguments.</paragraph>
44</section>
45<paragraph role="heading" id="hd_id3148943" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
46<paragraph role="paragraph" id="par_id3147560" xml-lang="en-US" l10n="U" oldref="4">Choose (Index, Selection1[, Selection2, ... [,Selection_n]])</paragraph>
47<paragraph role="heading" id="hd_id3154346" xml-lang="en-US" level="2" l10n="U" oldref="5">Parameters:</paragraph>
48<paragraph role="paragraph" id="par_id3148664" xml-lang="en-US" l10n="U" oldref="6">
49<emph>Index:</emph> A numeric expression that specifies the value to return.</paragraph>
50<paragraph role="paragraph" id="par_id3150791" xml-lang="en-US" l10n="U" oldref="7">
51<emph>Selection1:</emph> Any expression that contains one of the possible choices.</paragraph>
52<paragraph role="paragraph" id="par_id3151043" xml-lang="en-US" l10n="U" oldref="8">The <emph>Choose</emph> function returns a value from the list of expressions based on the index value. If Index = 1, the function returns the first expression in the list, if index i= 2, it returns the second expression, and so on.</paragraph>
53<paragraph role="paragraph" id="par_id3153192" xml-lang="en-US" l10n="U" oldref="9">If the index value is less than 1 or greater than the number of expressions listed, the function returns a Null value.</paragraph>
54<paragraph role="paragraph" id="par_id3156281" xml-lang="en-US" l10n="U" oldref="10">The following example uses the <emph>Choose</emph> function to select a string from several strings that form a menu:</paragraph>
55<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
56<embed href="text/sbasic/shared/00000003.xhp#err5"/>
57<paragraph role="heading" id="hd_id3150439" xml-lang="en-US" level="2" l10n="U" oldref="11">Example:</paragraph>
58<paragraph role="paragraph" id="par_id3153091" xml-lang="en-US" l10n="U" oldref="12">Sub ExampleChoose</paragraph>
59<paragraph role="paragraph" id="par_id3152597" xml-lang="en-US" l10n="U" oldref="13">Dim sReturn As String</paragraph>
60<paragraph role="paragraph" id="par_id3155855" xml-lang="en-US" l10n="U" oldref="14">sReturn = ChooseMenu(2)</paragraph>
61<paragraph role="paragraph" id="par_id3148575" xml-lang="en-US" l10n="U" oldref="15">Print sReturn</paragraph>
62<paragraph role="paragraph" id="par_id3154012" xml-lang="en-US" l10n="U" oldref="16">end sub</paragraph>
63<paragraph role="paragraph" id="par_id3146921" xml-lang="en-US" l10n="U" oldref="19">Function ChooseMenu(Index As Integer)</paragraph>
64<paragraph role="paragraph" id="par_id3156443" xml-lang="en-US" l10n="U" oldref="20">ChooseMenu = Choose(Index, "Quick Format", "Save Format", "System Format")</paragraph>
65<paragraph role="paragraph" id="par_id3148645" xml-lang="en-US" l10n="U" oldref="21">End Function</paragraph>
66</body>
67</helpdocument>
68