1<?xml version="1.0" encoding="UTF-8"?> 2 3 4<!--*********************************************************** 5 * 6 * Licensed to the Apache Software Foundation (ASF) under one 7 * or more contributor license agreements. See the NOTICE file 8 * distributed with this work for additional information 9 * regarding copyright ownership. The ASF licenses this file 10 * to you under the Apache License, Version 2.0 (the 11 * "License"); you may not use this file except in compliance 12 * with the License. You may obtain a copy of the License at 13 * 14 * http://www.apache.org/licenses/LICENSE-2.0 15 * 16 * Unless required by applicable law or agreed to in writing, 17 * software distributed under the License is distributed on an 18 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 19 * KIND, either express or implied. See the License for the 20 * specific language governing permissions and limitations 21 * under the License. 22 * 23 ***********************************************************--> 24 25 26 27<helpdocument version="1.0"> 28<meta> 29<topic id="textsbasicshared03090406xml" indexer="include" status="PUBLISH"> 30<title id="tit" xml-lang="en-US">Function Statement [Runtime]</title> 31<filename>/text/sbasic/shared/03090406.xhp</filename> 32</topic> 33<history> 34<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> 35<lastedited date="2004-08-24T12:12:48">converted from old format - fpe</lastedited> 36</history> 37</meta> 38<body> 39<section id="function"> 40<bookmark xml-lang="en-US" branch="index" id="bm_id3153346"><bookmark_value>Function statement</bookmark_value> 41</bookmark> 42<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> 43<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> 44</section> 45<paragraph role="heading" id="hd_id3145316" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax</paragraph> 46<paragraph role="paragraph" id="par_id3148944" xml-lang="en-US" l10n="U" oldref="4">see Parameter</paragraph> 47<paragraph role="heading" id="hd_id3154760" xml-lang="en-US" level="2" l10n="U" oldref="5">Parameters:</paragraph> 48<paragraph role="paragraph" id="par_id3156344" xml-lang="en-US" l10n="U" oldref="6">Syntax</paragraph> 49<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> 50<paragraph role="paragraph" id="par_id3153360" xml-lang="en-US" l10n="U" oldref="8">statement block</paragraph> 51<paragraph role="paragraph" id="par_id3148797" xml-lang="en-US" l10n="U" oldref="9">[Exit Function]</paragraph> 52<paragraph role="paragraph" id="par_id3145419" xml-lang="en-US" l10n="U" oldref="10">statement block</paragraph> 53<paragraph role="paragraph" id="par_id3150449" xml-lang="en-US" l10n="U" oldref="11">End Function</paragraph> 54<paragraph role="paragraph" id="par_id3156281" xml-lang="en-US" l10n="U" oldref="12">Parameter</paragraph> 55<paragraph role="paragraph" id="par_id3153193" xml-lang="en-US" l10n="U" oldref="13"> 56<emph>Name:</emph> Name of the subroutine to contain the value returned by the function.</paragraph> 57<paragraph role="paragraph" id="par_id3147229" xml-lang="en-US" l10n="U" oldref="14"> 58<emph>VarName:</emph> Parameter to be passed to the subroutine.</paragraph> 59<paragraph role="paragraph" id="par_id3147287" xml-lang="en-US" l10n="U" oldref="15"> 60<emph>Type:</emph> Type-declaration keyword.</paragraph> 61<paragraph role="heading" id="hd_id3163710" xml-lang="en-US" level="2" l10n="U" oldref="16">Example:</paragraph> 62<paragraph role="paragraph" id="par_id3147214" xml-lang="en-US" l10n="U" oldref="17">Sub ExampleExit</paragraph> 63<paragraph role="paragraph" id="par_id3152596" xml-lang="en-US" l10n="U" oldref="18">Dim sReturn As String</paragraph> 64<paragraph role="paragraph" id="par_id3153364" xml-lang="en-US" l10n="U" oldref="19">Dim sListArray(10) as String</paragraph> 65<paragraph role="paragraph" id="par_id3149481" xml-lang="en-US" l10n="U" oldref="20">Dim siStep as Single</paragraph> 66<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> 67<paragraph role="paragraph" id="par_id3147349" xml-lang="en-US" l10n="U" oldref="22">sListArray(siStep) = chr$(siStep + 65)</paragraph> 68<paragraph role="paragraph" id="par_id3147426" xml-lang="en-US" l10n="U" oldref="23">msgbox sListArray(siStep)</paragraph> 69<paragraph role="paragraph" id="par_id3152576" xml-lang="en-US" l10n="U" oldref="24">next siStep</paragraph> 70<paragraph role="paragraph" id="par_id3146922" xml-lang="en-US" l10n="U" oldref="25">sReturn = LinSearch(sListArray(), "B")</paragraph> 71<paragraph role="paragraph" id="par_id3153140" xml-lang="en-US" l10n="U" oldref="26">Print sReturn</paragraph> 72<paragraph role="paragraph" id="par_id3149581" xml-lang="en-US" l10n="U" oldref="27">end sub</paragraph> 73<paragraph role="paragraph" id="par_id3154790" xml-lang="en-US" l10n="U" oldref="30">Function LinSearch( sList(), sItem As String ) as integer</paragraph> 74<paragraph role="paragraph" id="par_id3150594" xml-lang="en-US" l10n="U" oldref="31">dim iCount as Integer</paragraph> 75<paragraph role="paragraph" id="par_id3154943" xml-lang="en-US" l10n="U" oldref="32">REM Linsearch searches a TextArray:sList() for a TextEntry:</paragraph> 76<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> 77<paragraph role="paragraph" id="par_id3154511" xml-lang="en-US" l10n="U" oldref="34">for iCount=1 to Ubound( sList() )</paragraph> 78<paragraph role="paragraph" id="par_id3149123" xml-lang="en-US" l10n="U" oldref="35">if sList( iCount ) = sItem then</paragraph> 79<paragraph role="paragraph" id="par_id3153707" xml-lang="en-US" l10n="U" oldref="36">exit for REM sItem found</paragraph> 80<paragraph role="paragraph" id="par_id3155066" xml-lang="en-US" l10n="U" oldref="37">end if</paragraph> 81<paragraph role="paragraph" id="par_id3156275" xml-lang="en-US" l10n="U" oldref="38">next iCount</paragraph> 82<paragraph role="paragraph" id="par_id3156054" xml-lang="en-US" l10n="U" oldref="39">if iCount = Ubound( sList() ) then iCount = 0</paragraph> 83<paragraph role="paragraph" id="par_id3153765" xml-lang="en-US" l10n="U" oldref="40">LinSearch = iCount</paragraph> 84<paragraph role="paragraph" id="par_id3153713" xml-lang="en-US" l10n="U" oldref="41">end function</paragraph> 85</body> 86</helpdocument> 87