1*cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?> 2*cdf0e10cSrcweir 3*cdf0e10cSrcweir 4*cdf0e10cSrcweir<!--*********************************************************************** 5*cdf0e10cSrcweir * 6*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 7*cdf0e10cSrcweir * 8*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 9*cdf0e10cSrcweir * 10*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 11*cdf0e10cSrcweir * 12*cdf0e10cSrcweir * This file is part of OpenOffice.org. 13*cdf0e10cSrcweir * 14*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 15*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 16*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 17*cdf0e10cSrcweir * 18*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 19*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 20*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 22*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 23*cdf0e10cSrcweir * 24*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 25*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 26*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 27*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 28*cdf0e10cSrcweir * 29*cdf0e10cSrcweir ************************************************************************--> 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir<helpdocument version="1.0"> 32*cdf0e10cSrcweir<meta> 33*cdf0e10cSrcweir<topic id="textsbasicshared03120401xml" indexer="include" status="PUBLISH"> 34*cdf0e10cSrcweir<title id="tit" xml-lang="en-US">InStr Function [Runtime]</title> 35*cdf0e10cSrcweir<filename>/text/sbasic/shared/03120401.xhp</filename> 36*cdf0e10cSrcweir</topic> 37*cdf0e10cSrcweir<history> 38*cdf0e10cSrcweir<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> 39*cdf0e10cSrcweir<lastedited date="2004-10-19T09:08:27">converted from old format - fpe 40*cdf0e10cSrcweirDEDR: Reviewed</lastedited> 41*cdf0e10cSrcweir</history> 42*cdf0e10cSrcweir</meta> 43*cdf0e10cSrcweir<body> 44*cdf0e10cSrcweir<section id="instr"> 45*cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="index" id="bm_id3155934"><bookmark_value>InStr function</bookmark_value> 46*cdf0e10cSrcweir</bookmark> 47*cdf0e10cSrcweir<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> 48*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153990" xml-lang="en-US" l10n="U" oldref="2">Returns the position of a string within another string.</paragraph> 49*cdf0e10cSrcweir</section> 50*cdf0e10cSrcweir<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> 51*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145090" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph> 52*cdf0e10cSrcweir<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> 53*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3148538" xml-lang="en-US" level="2" l10n="U" oldref="6">Return value:</paragraph> 54*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149763" xml-lang="en-US" l10n="U" oldref="7">Integer</paragraph> 55*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3148473" xml-lang="en-US" level="2" l10n="U" oldref="8">Parameters:</paragraph> 56*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153126" xml-lang="en-US" l10n="CHG" oldref="9"> 57*cdf0e10cSrcweir<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> 58*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3145609" xml-lang="en-US" l10n="U" oldref="10"> 59*cdf0e10cSrcweir<emph>Text1:</emph> The string expression that you want to search.</paragraph> 60*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147559" xml-lang="en-US" l10n="U" oldref="11"> 61*cdf0e10cSrcweir<emph>Text2:</emph> The string expression that you want to search for.</paragraph> 62*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154758" xml-lang="en-US" l10n="CHG" oldref="12"> 63*cdf0e10cSrcweir<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> 64*cdf0e10cSrcweir<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> 65*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> 66*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/> 67*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3154366" xml-lang="en-US" level="2" l10n="U" oldref="14">Example:</paragraph> 68*cdf0e10cSrcweir<paragraph role="code" id="par_id3154217" xml-lang="en-US" l10n="U" oldref="15">Sub ExamplePosition</paragraph> 69*cdf0e10cSrcweir<paragraph role="code" id="par_id3154685" xml-lang="en-US" l10n="U" oldref="16">Dim sInput As String</paragraph> 70*cdf0e10cSrcweir<paragraph role="code" id="par_id3151042" xml-lang="en-US" l10n="U" oldref="17">Dim iPos as Integer</paragraph> 71*cdf0e10cSrcweir<paragraph role="code" id="par_id3144760" xml-lang="en-US" l10n="CHG" oldref="19">sInput = "Office"</paragraph> 72*cdf0e10cSrcweir<paragraph role="code" id="par_id3154125" xml-lang="en-US" l10n="CHG" oldref="20">iPos = Instr(sInput,"c")</paragraph> 73*cdf0e10cSrcweir<paragraph role="code" id="par_id3145173" xml-lang="en-US" l10n="U" oldref="21">print iPos</paragraph> 74*cdf0e10cSrcweir<paragraph role="code" id="par_id3145786" xml-lang="en-US" l10n="U" oldref="22">end sub</paragraph> 75*cdf0e10cSrcweir</body> 76*cdf0e10cSrcweir</helpdocument> 77