1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3d33d0967SAndrew Rist<!--***********************************************************
4253bff03Smseidel *
5d33d0967SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
6d33d0967SAndrew Rist * or more contributor license agreements.  See the NOTICE file
7d33d0967SAndrew Rist * distributed with this work for additional information
8d33d0967SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
9d33d0967SAndrew Rist * to you under the Apache License, Version 2.0 (the
10d33d0967SAndrew Rist * "License"); you may not use this file except in compliance
11d33d0967SAndrew Rist * with the License.  You may obtain a copy of the License at
12253bff03Smseidel *
13d33d0967SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
14253bff03Smseidel *
15d33d0967SAndrew Rist * Unless required by applicable law or agreed to in writing,
16d33d0967SAndrew Rist * software distributed under the License is distributed on an
17d33d0967SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18d33d0967SAndrew Rist * KIND, either express or implied.  See the License for the
19d33d0967SAndrew Rist * specific language governing permissions and limitations
20d33d0967SAndrew Rist * under the License.
21253bff03Smseidel *
22d33d0967SAndrew Rist ***********************************************************-->
23d33d0967SAndrew Rist
24cdf0e10cSrcweir<helpdocument version="1.0">
25cdf0e10cSrcweir<meta>
26cdf0e10cSrcweir<topic id="textsbasicshared03090402xml" indexer="include" status="PUBLISH">
27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">Choose Function [Runtime]</title>
28cdf0e10cSrcweir<filename>/text/sbasic/shared/03090402.xhp</filename>
29cdf0e10cSrcweir</topic>
30cdf0e10cSrcweir</meta>
31cdf0e10cSrcweir<body>
32cdf0e10cSrcweir<section id="choose">
33*c5ffc49bSmseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3143271">
34*c5ffc49bSmseidel<bookmark_value>Choose function</bookmark_value>
35cdf0e10cSrcweir</bookmark>
36cdf0e10cSrcweir<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>
37cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149234" xml-lang="en-US" l10n="U" oldref="2">Returns a selected value from a list of arguments.</paragraph>
38cdf0e10cSrcweir</section>
39cdf0e10cSrcweir<paragraph role="heading" id="hd_id3148943" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
40cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147560" xml-lang="en-US" l10n="U" oldref="4">Choose (Index, Selection1[, Selection2, ... [,Selection_n]])</paragraph>
41cdf0e10cSrcweir<paragraph role="heading" id="hd_id3154346" xml-lang="en-US" level="2" l10n="U" oldref="5">Parameters:</paragraph>
42cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148664" xml-lang="en-US" l10n="U" oldref="6">
43cdf0e10cSrcweir<emph>Index:</emph> A numeric expression that specifies the value to return.</paragraph>
44cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3150791" xml-lang="en-US" l10n="U" oldref="7">
45cdf0e10cSrcweir<emph>Selection1:</emph> Any expression that contains one of the possible choices.</paragraph>
46cdf0e10cSrcweir<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>
47cdf0e10cSrcweir<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>
48cdf0e10cSrcweir<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>
49cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
50cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
51cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150439" xml-lang="en-US" level="2" l10n="U" oldref="11">Example:</paragraph>
52cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153091" xml-lang="en-US" l10n="U" oldref="12">Sub ExampleChoose</paragraph>
53cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3152597" xml-lang="en-US" l10n="U" oldref="13">Dim sReturn As String</paragraph>
54cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3155855" xml-lang="en-US" l10n="U" oldref="14">sReturn = ChooseMenu(2)</paragraph>
55cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148575" xml-lang="en-US" l10n="U" oldref="15">Print sReturn</paragraph>
56cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154012" xml-lang="en-US" l10n="U" oldref="16">end sub</paragraph>
57cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3146921" xml-lang="en-US" l10n="U" oldref="19">Function ChooseMenu(Index As Integer)</paragraph>
58cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156443" xml-lang="en-US" l10n="U" oldref="20">ChooseMenu = Choose(Index, "Quick Format", "Save Format", "System Format")</paragraph>
59cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148645" xml-lang="en-US" l10n="U" oldref="21">End Function</paragraph>
60cdf0e10cSrcweir</body>
61cdf0e10cSrcweir</helpdocument>
62