helpcontent2/source/text/sbasic/shared/03090406.xhp

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3
   4 <!--***********************************************************************
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * Copyright 2008 by Sun Microsystems, Inc.
   9  *
  10  * OpenOffice.org - a multi-platform office productivity suite
  11  *
  12  * $RCSfile: 03090406.xhp,v $
  13  * $Revision: 1.5 $
  14  *
  15  * This file is part of OpenOffice.org.
  16  *
  17  * OpenOffice.org is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU Lesser General Public License version 3
  19  * only, as published by the Free Software Foundation.
  20  *
  21  * OpenOffice.org is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU Lesser General Public License version 3 for more details
  25  * (a copy is included in the LICENSE file that accompanied this code).
  26  *
  27  * You should have received a copy of the GNU Lesser General Public License
  28  * version 3 along with OpenOffice.org.  If not, see
  29  * <http://www.openoffice.org/license.html>
  30  * for a copy of the LGPLv3 License.
  31  *
  32  ************************************************************************-->
  33
  34 <helpdocument version="1.0">
  35 <meta>
  36 <topic id="textsbasicshared03090406xml" indexer="include" status="PUBLISH">
  37 <title id="tit" xml-lang="en-US">Function Statement [Runtime]</title>
  38 <filename>/text/sbasic/shared/03090406.xhp</filename>
  39 </topic>
  40 <history>
  41 <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
  42 <lastedited date="2004-08-24T12:12:48">converted from old format - fpe</lastedited>
  43 </history>
  44 </meta>
  45 <body>
  46 <section id="function">
  47 <bookmark xml-lang="en-US" branch="index" id="bm_id3153346"><bookmark_value>Function statement</bookmark_value>
  48 </bookmark>
  49 <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>
  50 <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>
  51 </section>
  52 <paragraph role="heading" id="hd_id3145316" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax</paragraph>
  53 <paragraph role="paragraph" id="par_id3148944" xml-lang="en-US" l10n="U" oldref="4">see Parameter</paragraph>
  54 <paragraph role="heading" id="hd_id3154760" xml-lang="en-US" level="2" l10n="U" oldref="5">Parameters:</paragraph>
  55 <paragraph role="paragraph" id="par_id3156344" xml-lang="en-US" l10n="U" oldref="6">Syntax</paragraph>
  56 <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>
  57 <paragraph role="paragraph" id="par_id3153360" xml-lang="en-US" l10n="U" oldref="8">statement block</paragraph>
  58 <paragraph role="paragraph" id="par_id3148797" xml-lang="en-US" l10n="U" oldref="9">[Exit Function]</paragraph>
  59 <paragraph role="paragraph" id="par_id3145419" xml-lang="en-US" l10n="U" oldref="10">statement block</paragraph>
  60 <paragraph role="paragraph" id="par_id3150449" xml-lang="en-US" l10n="U" oldref="11">End Function</paragraph>
  61 <paragraph role="paragraph" id="par_id3156281" xml-lang="en-US" l10n="U" oldref="12">Parameter</paragraph>
  62 <paragraph role="paragraph" id="par_id3153193" xml-lang="en-US" l10n="U" oldref="13">
  63 <emph>Name:</emph> Name of the subroutine to contain the value returned by the function.</paragraph>
  64 <paragraph role="paragraph" id="par_id3147229" xml-lang="en-US" l10n="U" oldref="14">
  65 <emph>VarName:</emph> Parameter to be passed to the subroutine.</paragraph>
  66 <paragraph role="paragraph" id="par_id3147287" xml-lang="en-US" l10n="U" oldref="15">
  67 <emph>Type:</emph> Type-declaration keyword.</paragraph>
  68 <paragraph role="heading" id="hd_id3163710" xml-lang="en-US" level="2" l10n="U" oldref="16">Example:</paragraph>
  69 <paragraph role="paragraph" id="par_id3147214" xml-lang="en-US" l10n="U" oldref="17">Sub ExampleExit</paragraph>
  70 <paragraph role="paragraph" id="par_id3152596" xml-lang="en-US" l10n="U" oldref="18">Dim sReturn As String</paragraph>
  71 <paragraph role="paragraph" id="par_id3153364" xml-lang="en-US" l10n="U" oldref="19">Dim sListArray(10) as String</paragraph>
  72 <paragraph role="paragraph" id="par_id3149481" xml-lang="en-US" l10n="U" oldref="20">Dim siStep as Single</paragraph>
  73 <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>
  74 <paragraph role="paragraph" id="par_id3147349" xml-lang="en-US" l10n="U" oldref="22">sListArray(siStep) = chr$(siStep + 65)</paragraph>
  75 <paragraph role="paragraph" id="par_id3147426" xml-lang="en-US" l10n="U" oldref="23">msgbox sListArray(siStep)</paragraph>
  76 <paragraph role="paragraph" id="par_id3152576" xml-lang="en-US" l10n="U" oldref="24">next siStep</paragraph>
  77 <paragraph role="paragraph" id="par_id3146922" xml-lang="en-US" l10n="U" oldref="25">sReturn = LinSearch(sListArray(), "B")</paragraph>
  78 <paragraph role="paragraph" id="par_id3153140" xml-lang="en-US" l10n="U" oldref="26">Print sReturn</paragraph>
  79 <paragraph role="paragraph" id="par_id3149581" xml-lang="en-US" l10n="U" oldref="27">end sub</paragraph>
  80 <paragraph role="paragraph" id="par_id3154790" xml-lang="en-US" l10n="U" oldref="30">Function LinSearch( sList(), sItem As String ) as integer</paragraph>
  81 <paragraph role="paragraph" id="par_id3150594" xml-lang="en-US" l10n="U" oldref="31">dim iCount as Integer</paragraph>
  82 <paragraph role="paragraph" id="par_id3154943" xml-lang="en-US" l10n="U" oldref="32">REM Linsearch searches a TextArray:sList() for a TextEntry:</paragraph>
  83 <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>
  84 <paragraph role="paragraph" id="par_id3154511" xml-lang="en-US" l10n="U" oldref="34">for iCount=1 to Ubound( sList() )</paragraph>
  85 <paragraph role="paragraph" id="par_id3149123" xml-lang="en-US" l10n="U" oldref="35">if sList( iCount ) = sItem then</paragraph>
  86 <paragraph role="paragraph" id="par_id3153707" xml-lang="en-US" l10n="U" oldref="36">exit for REM sItem found</paragraph>
  87 <paragraph role="paragraph" id="par_id3155066" xml-lang="en-US" l10n="U" oldref="37">end if</paragraph>
  88 <paragraph role="paragraph" id="par_id3156275" xml-lang="en-US" l10n="U" oldref="38">next iCount</paragraph>
  89 <paragraph role="paragraph" id="par_id3156054" xml-lang="en-US" l10n="U" oldref="39">if iCount = Ubound( sList() ) then iCount = 0</paragraph>
  90 <paragraph role="paragraph" id="par_id3153765" xml-lang="en-US" l10n="U" oldref="40">LinSearch = iCount</paragraph>
  91 <paragraph role="paragraph" id="par_id3153713" xml-lang="en-US" l10n="U" oldref="41">end function</paragraph>
  92 </body>
  93 </helpdocument>