1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?> 2cdf0e10cSrcweir 3d33d0967SAndrew Rist<!--*********************************************************** 410be1ba9Smseidel * 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 1210be1ba9Smseidel * 13d33d0967SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 1410be1ba9Smseidel * 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. 2110be1ba9Smseidel * 22d33d0967SAndrew Rist ***********************************************************--> 23d33d0967SAndrew Rist 24cdf0e10cSrcweir<helpdocument version="1.0"> 25cdf0e10cSrcweir<meta> 26cdf0e10cSrcweir<topic id="textsbasicshared03090406xml" indexer="include" status="PUBLISH"> 27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">Function Statement [Runtime]</title> 28cdf0e10cSrcweir<filename>/text/sbasic/shared/03090406.xhp</filename> 29cdf0e10cSrcweir</topic> 30cdf0e10cSrcweir</meta> 31cdf0e10cSrcweir<body> 32cdf0e10cSrcweir<section id="function"> 33*1832f669Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3153346"> 34*1832f669Smseidel<bookmark_value>Function statement</bookmark_value> 35cdf0e10cSrcweir</bookmark> 36cdf0e10cSrcweir<paragraph role="heading" id="hd_id3153346" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03090406.xhp" name="Function Statement [Runtime]">Function Statement [Runtime]</link></paragraph> 37cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3159158" xml-lang="en-US" l10n="U" oldref="2">Defines a subroutine that can be used as an expression to determine a return type.</paragraph> 38cdf0e10cSrcweir</section> 39cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145316" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax</paragraph> 40cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148944" xml-lang="en-US" l10n="U" oldref="4">see Parameter</paragraph> 41cdf0e10cSrcweir<paragraph role="heading" id="hd_id3154760" xml-lang="en-US" level="2" l10n="U" oldref="5">Parameters:</paragraph> 42cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156344" xml-lang="en-US" l10n="U" oldref="6">Syntax</paragraph> 43cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149457" xml-lang="en-US" l10n="U" oldref="7">Function Name[(VarName1 [As Type][, VarName2 [As Type][,...]]]) [As Type]</paragraph> 44cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153360" xml-lang="en-US" l10n="U" oldref="8">statement block</paragraph> 45cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148797" xml-lang="en-US" l10n="U" oldref="9">[Exit Function]</paragraph> 46cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3145419" xml-lang="en-US" l10n="U" oldref="10">statement block</paragraph> 47cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3150449" xml-lang="en-US" l10n="U" oldref="11">End Function</paragraph> 48cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156281" xml-lang="en-US" l10n="U" oldref="12">Parameter</paragraph> 49cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153193" xml-lang="en-US" l10n="U" oldref="13"> 50cdf0e10cSrcweir<emph>Name:</emph> Name of the subroutine to contain the value returned by the function.</paragraph> 51cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147229" xml-lang="en-US" l10n="U" oldref="14"> 52cdf0e10cSrcweir<emph>VarName:</emph> Parameter to be passed to the subroutine.</paragraph> 53cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147287" xml-lang="en-US" l10n="U" oldref="15"> 54cdf0e10cSrcweir<emph>Type:</emph> Type-declaration keyword.</paragraph> 55cdf0e10cSrcweir<paragraph role="heading" id="hd_id3163710" xml-lang="en-US" level="2" l10n="U" oldref="16">Example:</paragraph> 56cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147214" xml-lang="en-US" l10n="U" oldref="17">Sub ExampleExit</paragraph> 57cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3152596" xml-lang="en-US" l10n="U" oldref="18">Dim sReturn As String</paragraph> 58cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153364" xml-lang="en-US" l10n="U" oldref="19">Dim sListArray(10) as String</paragraph> 59cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149481" xml-lang="en-US" l10n="U" oldref="20">Dim siStep as Single</paragraph> 60cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3152939" xml-lang="en-US" l10n="U" oldref="21">For siStep = 0 to 10 REM Fill array with test data</paragraph> 61cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147349" xml-lang="en-US" l10n="U" oldref="22">sListArray(siStep) = chr$(siStep + 65)</paragraph> 62cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147426" xml-lang="en-US" l10n="U" oldref="23">msgbox sListArray(siStep)</paragraph> 63cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3152576" xml-lang="en-US" l10n="U" oldref="24">next siStep</paragraph> 64cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3146922" xml-lang="en-US" l10n="U" oldref="25">sReturn = LinSearch(sListArray(), "B")</paragraph> 65cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153140" xml-lang="en-US" l10n="U" oldref="26">Print sReturn</paragraph> 66cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149581" xml-lang="en-US" l10n="U" oldref="27">end sub</paragraph> 67cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154790" xml-lang="en-US" l10n="U" oldref="30">Function LinSearch( sList(), sItem As String ) as integer</paragraph> 68cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3150594" xml-lang="en-US" l10n="U" oldref="31">dim iCount as Integer</paragraph> 69cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154943" xml-lang="en-US" l10n="U" oldref="32">REM Linsearch searches a TextArray:sList() for a TextEntry:</paragraph> 70cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3155601" xml-lang="en-US" l10n="U" oldref="33">REM Return value is the index of the entry or 0 (Null)</paragraph> 71cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154511" xml-lang="en-US" l10n="U" oldref="34">for iCount=1 to Ubound( sList() )</paragraph> 72cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149123" xml-lang="en-US" l10n="U" oldref="35">if sList( iCount ) = sItem then</paragraph> 73cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153707" xml-lang="en-US" l10n="U" oldref="36">exit for REM sItem found</paragraph> 74cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3155066" xml-lang="en-US" l10n="U" oldref="37">end if</paragraph> 75cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156275" xml-lang="en-US" l10n="U" oldref="38">next iCount</paragraph> 76cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156054" xml-lang="en-US" l10n="U" oldref="39">if iCount = Ubound( sList() ) then iCount = 0</paragraph> 77cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153765" xml-lang="en-US" l10n="U" oldref="40">LinSearch = iCount</paragraph> 78cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153713" xml-lang="en-US" l10n="U" oldref="41">end function</paragraph> 79cdf0e10cSrcweir</body> 80cdf0e10cSrcweir</helpdocument> 81