summaryrefslogtreecommitdiffstats
path: root/source/text/sbasic/shared/03120401.xhp
diff options
context:
space:
mode:
Diffstat (limited to 'source/text/sbasic/shared/03120401.xhp')
-rw-r--r--source/text/sbasic/shared/03120401.xhp76
1 files changed, 76 insertions, 0 deletions
diff --git a/source/text/sbasic/shared/03120401.xhp b/source/text/sbasic/shared/03120401.xhp
new file mode 100644
index 0000000000..7595415613
--- /dev/null
+++ b/source/text/sbasic/shared/03120401.xhp
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+
+<!--***********************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************-->
+
+<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>
+<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>
+<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>
+<paragraph role="code" id="par_id3154217" xml-lang="en-US" l10n="U" oldref="15">Sub ExamplePosition</paragraph>
+<paragraph role="code" id="par_id3154685" xml-lang="en-US" l10n="U" oldref="16">Dim sInput As String</paragraph>
+<paragraph role="code" id="par_id3151042" xml-lang="en-US" l10n="U" oldref="17">Dim iPos as Integer</paragraph>
+<paragraph role="code" id="par_id3144760" xml-lang="en-US" l10n="CHG" oldref="19">sInput = "Office"</paragraph>
+<paragraph role="code" id="par_id3154125" xml-lang="en-US" l10n="CHG" oldref="20">iPos = Instr(sInput,"c")</paragraph>
+<paragraph role="code" id="par_id3145173" xml-lang="en-US" l10n="U" oldref="21">print iPos</paragraph>
+<paragraph role="code" id="par_id3145786" xml-lang="en-US" l10n="U" oldref="22">end sub</paragraph>
+</body>
+</helpdocument>