1<?xml version="1.0" encoding="UTF-8"?>
2
3<!--***********************************************************
4 *
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements.  See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership.  The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License.  You may obtain a copy of the License at
12 *
13 *   http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied.  See the License for the
19 * specific language governing permissions and limitations
20 * under the License.
21 *
22 ***********************************************************-->
23
24<helpdocument version="1.0">
25<meta>
26<topic id="textsbasicshared03120401xml" indexer="include" status="PUBLISH">
27<title id="tit" xml-lang="en-US">InStr Function [Runtime]</title>
28<filename>/text/sbasic/shared/03120401.xhp</filename>
29</topic>
30</meta>
31<body>
32<section id="instr">
33<bookmark xml-lang="en-US" branch="index" id="bm_id3155934">
34<bookmark_value>InStr function</bookmark_value>
35</bookmark>
36<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>
37<paragraph role="paragraph" id="par_id3153990" xml-lang="en-US" l10n="U" oldref="2">Returns the position of a string within another string.</paragraph>
38</section>
39<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>
40<paragraph role="heading" id="hd_id3145090" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph>
41<paragraph role="code" id="par_id3146957" xml-lang="en-US" l10n="U" oldref="5">InStr ([Start As Long,] Text1 As String, Text2 As String[, Compare])</paragraph>
42<paragraph role="heading" id="hd_id3148538" xml-lang="en-US" level="2" l10n="U" oldref="6">Return value:</paragraph>
43<paragraph role="paragraph" id="par_id3149763" xml-lang="en-US" l10n="U" oldref="7">Integer</paragraph>
44<paragraph role="heading" id="hd_id3148473" xml-lang="en-US" level="2" l10n="U" oldref="8">Parameters:</paragraph>
45<paragraph role="paragraph" id="par_id3153126" xml-lang="en-US" l10n="CHG" oldref="9">
46<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>UFI: see #i17928#</comment></paragraph>
47<paragraph role="paragraph" id="par_id3145609" xml-lang="en-US" l10n="U" oldref="10">
48<emph>Text1:</emph> The string expression that you want to search.</paragraph>
49<paragraph role="paragraph" id="par_id3147559" xml-lang="en-US" l10n="U" oldref="11">
50<emph>Text2:</emph> The string expression that you want to search for.</paragraph>
51<paragraph role="paragraph" id="par_id3154758" xml-lang="en-US" l10n="CHG" oldref="12">
52<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>UFI: fixes #i17929#</comment></paragraph>
53<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>
54<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
55<embed href="text/sbasic/shared/00000003.xhp#err5"/>
56<paragraph role="heading" id="hd_id3154366" xml-lang="en-US" level="2" l10n="U" oldref="14">Example:</paragraph>
57<paragraph role="code" id="par_id3154217" xml-lang="en-US" l10n="U" oldref="15">Sub ExamplePosition</paragraph>
58<paragraph role="code" id="par_id3154685" xml-lang="en-US" l10n="U" oldref="16">Dim sInput As String</paragraph>
59<paragraph role="code" id="par_id3151042" xml-lang="en-US" l10n="U" oldref="17">Dim iPos as Integer</paragraph>
60<paragraph role="code" id="par_id3144760" xml-lang="en-US" l10n="CHG" oldref="19">sInput = "Office"</paragraph>
61<paragraph role="code" id="par_id3154125" xml-lang="en-US" l10n="CHG" oldref="20">iPos = Instr(sInput,"c")</paragraph>
62<paragraph role="code" id="par_id3145173" xml-lang="en-US" l10n="U" oldref="21">print iPos</paragraph>
63<paragraph role="code" id="par_id3145786" xml-lang="en-US" l10n="U" oldref="22">end sub</paragraph>
64</body>
65</helpdocument>
66