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