1*cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2*cdf0e10cSrcweir
3*cdf0e10cSrcweir
4*cdf0e10cSrcweir<!--***********************************************************************
5*cdf0e10cSrcweir *
6*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7*cdf0e10cSrcweir *
8*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
9*cdf0e10cSrcweir *
10*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
11*cdf0e10cSrcweir *
12*cdf0e10cSrcweir * This file is part of OpenOffice.org.
13*cdf0e10cSrcweir *
14*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
15*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
16*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
17*cdf0e10cSrcweir *
18*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
19*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
20*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
22*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
23*cdf0e10cSrcweir *
24*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
25*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
26*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
27*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
28*cdf0e10cSrcweir *
29*cdf0e10cSrcweir ************************************************************************-->
30*cdf0e10cSrcweir
31*cdf0e10cSrcweir<helpdocument version="1.0">
32*cdf0e10cSrcweir<meta>
33*cdf0e10cSrcweir<topic id="textsbasicshared03090410xml" indexer="include" status="PUBLISH">
34*cdf0e10cSrcweir<title id="tit" xml-lang="en-US">Switch Function [Runtime]</title>
35*cdf0e10cSrcweir<filename>/text/sbasic/shared/03090410.xhp</filename>
36*cdf0e10cSrcweir</topic>
37*cdf0e10cSrcweir<history>
38*cdf0e10cSrcweir<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
39*cdf0e10cSrcweir<lastedited date="2004-08-24T14:34:49">converted from old format - fpe</lastedited>
40*cdf0e10cSrcweir</history>
41*cdf0e10cSrcweir</meta>
42*cdf0e10cSrcweir<body>
43*cdf0e10cSrcweir<section id="switch">
44*cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="index" id="bm_id3148554"><bookmark_value>Switch function</bookmark_value>
45*cdf0e10cSrcweir</bookmark>
46*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3148554" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03090410.xhp" name="Switch Function [Runtime]">Switch Function [Runtime]</link></paragraph>
47*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148522" xml-lang="en-US" l10n="U" oldref="2">Evaluates a list of arguments, consisting of an expression followed by a value. The Switch function returns a value that is associated with the expression that is passed by this function.</paragraph>
48*cdf0e10cSrcweir</section>
49*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3154863" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
50*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3155934" xml-lang="en-US" l10n="U" oldref="4">Switch (Expression1, Value1[, Expression2, Value2[..., Expression_n, Value_n]])</paragraph>
51*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3149119" xml-lang="en-US" level="2" l10n="U" oldref="5">Parameters:</paragraph>
52*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153894" xml-lang="en-US" l10n="U" oldref="6">The <emph>Switch</emph> function evaluates the expressions from left to right, and then returns the value that is assigned to the function expression. If expression and value are not given as a pair, a runtime error occurs.</paragraph>
53*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153990" xml-lang="en-US" l10n="U" oldref="7">
54*cdf0e10cSrcweir<emph>Expression:</emph> The expression that you want to evaluate.</paragraph>
55*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153394" xml-lang="en-US" l10n="U" oldref="8">
56*cdf0e10cSrcweir<emph>Value:</emph> The value that you want to return if the expression is True.</paragraph>
57*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153346" xml-lang="en-US" l10n="U" oldref="9">In the following example, the <emph>Switch</emph> function assigns the appropriate gender to the name that is passed to the function:</paragraph>
58*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
59*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
60*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3159157" xml-lang="en-US" level="2" l10n="U" oldref="10">Example:</paragraph>
61*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147573" xml-lang="en-US" l10n="U" oldref="11">Sub ExampleSwitch</paragraph>
62*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3143270" xml-lang="en-US" l10n="U" oldref="12">Dim sGender As String</paragraph>
63*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149579" xml-lang="en-US" l10n="U" oldref="13">sGender = GetGenderIndex( "John" )</paragraph>
64*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153626" xml-lang="en-US" l10n="U" oldref="14">MsgBox sGender</paragraph>
65*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147560" xml-lang="en-US" l10n="U" oldref="15">End Sub</paragraph>
66*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154758" xml-lang="en-US" l10n="U" oldref="17">Function GetGenderIndex (sName As String) As String</paragraph>
67*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153361" xml-lang="en-US" l10n="U" oldref="18">GetGenderIndex = Switch(sName = "Jane", "female", sName = "John", "male")</paragraph>
68*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154939" xml-lang="en-US" l10n="U" oldref="19">End Function</paragraph>
69*cdf0e10cSrcweir</body>
70*cdf0e10cSrcweir</helpdocument>
71