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