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