blob: cca5fc2b2cc29d24924a21badb67d91e5253e275 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->
<meta>
<topic id="textsbasicshared03090406xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Function Statement [Runtime]</title>
<filename>/text/sbasic/shared/03090406.xhp</filename>
</topic>
</meta>
<body>
<section id="function">
<bookmark xml-lang="en-US" branch="index" id="bm_id3153346">
<bookmark_value>Function statement</bookmark_value>
</bookmark>
<paragraph id="hd_id3153346" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090406.xhp" name="Function Statement [Runtime]">Function Statement [Runtime]</link></paragraph>
<paragraph id="par_id3159158" role="paragraph" xml-lang="en-US">Defines a subroutine that can be used as an expression to determine a return type.</paragraph>
</section>
<paragraph id="hd_id3145316" role="heading" level="2" xml-lang="en-US">Syntax</paragraph>
<paragraph id="par_id3148944" role="paragraph" xml-lang="en-US">see Parameter</paragraph>
<paragraph id="hd_id3154760" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph>
<paragraph id="par_id3156344" role="paragraph" xml-lang="en-US">Syntax</paragraph>
<paragraph id="par_id3149457" role="paragraph" xml-lang="en-US">Function Name[(VarName1 [As Type][, VarName2 [As Type][,...]]]) [As Type]</paragraph>
<paragraph id="par_id3153360" role="paragraph" xml-lang="en-US">statement block</paragraph>
<paragraph id="par_id3148797" role="paragraph" xml-lang="en-US">[Exit Function]</paragraph>
<paragraph id="par_id3145419" role="paragraph" xml-lang="en-US">statement block</paragraph>
<paragraph id="par_id3150449" role="paragraph" xml-lang="en-US">End Function</paragraph>
<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">Parameter</paragraph>
<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US"> <emph>Name:</emph> Name of the subroutine to contain the value returned by the function.</paragraph>
<paragraph id="par_id3147229" role="paragraph" xml-lang="en-US"> <emph>VarName:</emph> Parameter to be passed to the subroutine.</paragraph>
<paragraph id="par_id3147287" role="paragraph" xml-lang="en-US"> <emph>Type:</emph> Type-declaration keyword.</paragraph>
<paragraph id="hd_id3163710" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
<bascode>
<paragraph id="par_idm1340981728" role="bascode" localize="false" xml-lang="en-US">Sub ExampleExit</paragraph>
<paragraph id="par_idm1340980496" role="bascode" localize="false" xml-lang="en-US">Dim sReturn As String</paragraph>
<paragraph id="par_idm1340979264" role="bascode" localize="false" xml-lang="en-US">Dim sListArray(10) As String</paragraph>
<paragraph id="par_idm1340978016" role="bascode" localize="false" xml-lang="en-US">Dim siStep As Single</paragraph>
<paragraph id="par_id3152939" role="bascode" xml-lang="en-US"> For siStep = 0 To 10 ' Fill array with test data</paragraph>
<paragraph id="par_idm1340975040" role="bascode" localize="false" xml-lang="en-US"> sListArray(siStep) = chr$(siStep + 65)</paragraph>
<paragraph id="par_idm1340973776" role="bascode" localize="false" xml-lang="en-US"> MsgBox sListArray(siStep)</paragraph>
<paragraph id="par_idm1340972528" role="bascode" localize="false" xml-lang="en-US"> Next siStep</paragraph>
<paragraph id="par_idm1340971296" role="bascode" localize="false" xml-lang="en-US"> sReturn = LinSearch(sListArray(), "B")</paragraph>
<paragraph id="par_idm1340970032" role="bascode" localize="false" xml-lang="en-US"> Print sReturn</paragraph>
<paragraph id="par_idm1340968800" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
<paragraph id="par_idm1340967568" role="bascode" localize="false" xml-lang="en-US"> </paragraph>
<paragraph id="par_idm1340966320" role="bascode" localize="false" xml-lang="en-US">Function LinSearch( sList(), sItem As String ) As Integer</paragraph>
<paragraph id="par_idm1340965040" role="bascode" localize="false" xml-lang="en-US">Dim iCount As Integer</paragraph>
<paragraph id="par_id3154943" role="bascode" xml-lang="en-US">' Linsearch searches a TextArray:sList() for a TextEntry:</paragraph>
<paragraph id="par_id3155601" role="bascode" xml-lang="en-US">' Return value Is the index of the entry Or 0 (Null)</paragraph>
<paragraph id="par_idm1340960304" role="bascode" localize="false" xml-lang="en-US"> For iCount=1 To Ubound( sList() )</paragraph>
<paragraph id="par_idm1340959056" role="bascode" localize="false" xml-lang="en-US"> If sList( iCount ) = sItem Then</paragraph>
<paragraph id="par_id3153707" role="bascode" xml-lang="en-US"> Exit For ' sItem found</paragraph>
<paragraph id="par_idm1340956080" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph>
<paragraph id="par_idm1340954848" role="bascode" localize="false" xml-lang="en-US"> Next iCount</paragraph>
<paragraph id="par_idm1340953616" role="bascode" localize="false" xml-lang="en-US"> If iCount = Ubound( sList() ) Then iCount = 0</paragraph>
<paragraph id="par_idm1340952352" role="bascode" localize="false" xml-lang="en-US"> LinSearch = iCount</paragraph>
<paragraph id="par_idm1340951120" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph>
</bascode>
</body>
</helpdocument>
|
