source/text/sbasic/shared/03120401.xhp


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

<?xml version="1.0" encoding="UTF-8"?>


<!--
 * 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 .
 -->
	
<helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03120401xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">InStr Function [Runtime]</title>
<filename>/text/sbasic/shared/03120401.xhp</filename>
</topic>
<history>
<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
<lastedited date="2004-10-19T09:08:27">converted from old format - fpe
DEDR: Reviewed</lastedited>
</history>
</meta>
<body>
<section id="instr">
<bookmark xml-lang="en-US" branch="index" id="bm_id3155934"><bookmark_value>InStr function</bookmark_value>
</bookmark>
<paragraph role="heading" id="hd_id3155934" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03120401.xhp" name="InStr Function [Runtime]">InStr Function [Runtime]</link></paragraph>
<paragraph role="paragraph" id="par_id3153990" xml-lang="en-US" l10n="U" oldref="2">Returns the position of a string within another string.</paragraph>
</section>
<paragraph role="paragraph" id="par_id3147303" xml-lang="en-US" l10n="U" oldref="3">The Instr function returns the position at which the match was found. If the string was not found, the function returns 0.</paragraph>
<paragraph role="heading" id="hd_id3145090" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph>
<bascode>
<paragraph role="bascode" id="par_id3146957" xml-lang="en-US" l10n="U" oldref="5">InStr ([Start As Long,] Text1 As String, Text2 As String[, Compare])</paragraph>
</bascode>
<paragraph role="heading" id="hd_id3148538" xml-lang="en-US" level="2" l10n="U" oldref="6">Return value:</paragraph>
<paragraph role="paragraph" id="par_id3149763" xml-lang="en-US" l10n="U" oldref="7">Integer</paragraph>
<paragraph role="heading" id="hd_id3148473" xml-lang="en-US" level="2" l10n="U" oldref="8">Parameters:</paragraph>
<paragraph role="paragraph" id="par_id3153126" xml-lang="en-US" l10n="CHG" oldref="9">
<emph>Start: </emph>A numeric expression that marks the position in a string where the search for the specified substring starts. If you omit this parameter, the search starts at the first character of the string. The maximum allowed value is 65535.<comment>see i17928</comment></paragraph>
<paragraph role="paragraph" id="par_id3145609" xml-lang="en-US" l10n="U" oldref="10">
<emph>Text1:</emph> The string expression that you want to search.</paragraph>
<paragraph role="paragraph" id="par_id3147559" xml-lang="en-US" l10n="U" oldref="11">
<emph>Text2:</emph> The string expression that you want to search for.</paragraph>
<paragraph role="paragraph" id="par_id3154758" xml-lang="en-US" l10n="CHG" oldref="12">
<emph>Compare:</emph> Optional numeric expression that defines the type of comparison. The value of this parameter can be 0 or 1. The default value of 1 specifies a text comparison that is not case-sensitive. The value of 0 specifies a binary comparison that is case-sensitive.<comment>fixes i17929</comment></paragraph>
<paragraph role="paragraph" id="par_id3153361" xml-lang="en-US" l10n="U" oldref="13">To avoid a run-time error, do not set the Compare parameter if the first return parameter is omitted.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<paragraph role="heading" id="hd_id3154366" xml-lang="en-US" level="2" l10n="U" oldref="14">Example:</paragraph>
<bascode>
<paragraph role="bascode" localize="false" xml-lang="en-US">Sub ExamplePosition</paragraph>
<paragraph role="bascode" localize="false" xml-lang="en-US">Dim sInput As String</paragraph>
<paragraph role="bascode" localize="false" xml-lang="en-US">Dim iPos As Integer</paragraph>
<paragraph role="bascode" id="par_id3144760" xml-lang="en-US" l10n="CHG" oldref="19">    sInput = "Office"</paragraph>
<paragraph role="bascode" id="par_id3154125" xml-lang="en-US" l10n="CHG" oldref="20">    iPos = Instr(sInput,"c")</paragraph>
<paragraph role="bascode" localize="false" xml-lang="en-US">    Print iPos</paragraph>
<paragraph role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>
</helpdocument>