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="textsbasicshared03090402xml" indexer="include" status="PUBLISH">
27<title id="tit" xml-lang="en-US">Choose Function [Runtime]</title>
28<filename>/text/sbasic/shared/03090402.xhp</filename>
29</topic>
30</meta>
31<body>
32<section id="choose">
33<bookmark xml-lang="en-US" branch="index" id="bm_id3143271">
34<bookmark_value>Choose function</bookmark_value>
35</bookmark>
36<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>
37<paragraph role="paragraph" id="par_id3149234" xml-lang="en-US" l10n="U" oldref="2">Returns a selected value from a list of arguments.</paragraph>
38</section>
39<paragraph role="heading" id="hd_id3148943" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
40<paragraph role="paragraph" id="par_id3147560" xml-lang="en-US" l10n="U" oldref="4">Choose (Index, Selection1[, Selection2, ... [,Selection_n]])</paragraph>
41<paragraph role="heading" id="hd_id3154346" xml-lang="en-US" level="2" l10n="U" oldref="5">Parameters:</paragraph>
42<paragraph role="paragraph" id="par_id3148664" xml-lang="en-US" l10n="U" oldref="6">
43<emph>Index:</emph> A numeric expression that specifies the value to return.</paragraph>
44<paragraph role="paragraph" id="par_id3150791" xml-lang="en-US" l10n="U" oldref="7">
45<emph>Selection1:</emph> Any expression that contains one of the possible choices.</paragraph>
46<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>
47<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>
48<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>
49<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
50<embed href="text/sbasic/shared/00000003.xhp#err5"/>
51<paragraph role="heading" id="hd_id3150439" xml-lang="en-US" level="2" l10n="U" oldref="11">Example:</paragraph>
52<paragraph role="paragraph" id="par_id3153091" xml-lang="en-US" l10n="U" oldref="12">Sub ExampleChoose</paragraph>
53<paragraph role="paragraph" id="par_id3152597" xml-lang="en-US" l10n="U" oldref="13">Dim sReturn As String</paragraph>
54<paragraph role="paragraph" id="par_id3155855" xml-lang="en-US" l10n="U" oldref="14">sReturn = ChooseMenu(2)</paragraph>
55<paragraph role="paragraph" id="par_id3148575" xml-lang="en-US" l10n="U" oldref="15">Print sReturn</paragraph>
56<paragraph role="paragraph" id="par_id3154012" xml-lang="en-US" l10n="U" oldref="16">end sub</paragraph>
57<paragraph role="paragraph" id="par_id3146921" xml-lang="en-US" l10n="U" oldref="19">Function ChooseMenu(Index As Integer)</paragraph>
58<paragraph role="paragraph" id="par_id3156443" xml-lang="en-US" l10n="U" oldref="20">ChooseMenu = Choose(Index, "Quick Format", "Save Format", "System Format")</paragraph>
59<paragraph role="paragraph" id="par_id3148645" xml-lang="en-US" l10n="U" oldref="21">End Function</paragraph>
60</body>
61</helpdocument>
62