1<?xml version="1.0" encoding="UTF-8"?>
2
3
4<!--***********************************************************
5 *
6 * Licensed to the Apache Software Foundation (ASF) under one
7 * or more contributor license agreements.  See the NOTICE file
8 * distributed with this work for additional information
9 * regarding copyright ownership.  The ASF licenses this file
10 * to you under the Apache License, Version 2.0 (the
11 * "License"); you may not use this file except in compliance
12 * with the License.  You may obtain a copy of the License at
13 *
14 *   http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing,
17 * software distributed under the License is distributed on an
18 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19 * KIND, either express or implied.  See the License for the
20 * specific language governing permissions and limitations
21 * under the License.
22 *
23 ***********************************************************-->
24
25
26
27<helpdocument version="1.0">
28<meta>
29<topic id="textsbasicshared03120403xml" indexer="include" status="PUBLISH">
30<title id="tit" xml-lang="en-US">StrComp Function [Runtime]</title>
31<filename>/text/sbasic/shared/03120403.xhp</filename>
32</topic>
33<history>
34<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
35<lastedited date="2004-08-24T14:33:33">converted from old format - fpe</lastedited>
36</history>
37</meta>
38<body>
39<section id="strcomp">
40<bookmark xml-lang="en-US" branch="index" id="bm_id3156027"><bookmark_value>StrComp function</bookmark_value>
41</bookmark>
42<paragraph role="heading" id="hd_id3156027" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03120403.xhp" name="StrComp Function [Runtime]">StrComp Function [Runtime]</link></paragraph>
43<paragraph role="paragraph" id="par_id3155805" xml-lang="en-US" l10n="U" oldref="2">Compares two strings and returns an integer value that represents the result of the comparison.</paragraph>
44</section>
45<paragraph role="heading" id="hd_id3153345" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
46<paragraph role="paragraph" id="par_id3150503" xml-lang="en-US" l10n="U" oldref="4">StrComp (Text1 As String, Text2 As String[, Compare])</paragraph>
47<paragraph role="heading" id="hd_id3147574" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
48<paragraph role="paragraph" id="par_id3156152" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph>
49<paragraph role="heading" id="hd_id3150984" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameter:</paragraph>
50<paragraph role="paragraph" id="par_id3153061" xml-lang="en-US" l10n="U" oldref="8">
51<emph>Text1:</emph> Any string expression</paragraph>
52<paragraph role="paragraph" id="par_id3147560" xml-lang="en-US" l10n="U" oldref="9">
53<emph>Text2:</emph> Any string expression</paragraph>
54<paragraph role="paragraph" id="par_id3146796" xml-lang="en-US" l10n="U" oldref="10">
55<emph>Compare:</emph> This optional parameter sets the comparison method. If Compare = 1, the string comparison is case-sensitive. If Compare = 0, no distinction is made between uppercase and lowercase letters.</paragraph>
56<paragraph role="heading" id="hd_id3154940" xml-lang="en-US" level="3" l10n="U" oldref="13">Return value</paragraph>
57<list type="unordered">
58<listitem>
59<paragraph role="listitem" id="par_id3150358" xml-lang="en-US" l10n="U" oldref="27">If Text1 &lt; Text2 the function returns -1</paragraph>
60</listitem>
61<listitem>
62<paragraph role="listitem" id="par_id3151043" xml-lang="en-US" l10n="U" oldref="28">If Text1 = Text2 the function returns 0</paragraph>
63</listitem>
64<listitem>
65<paragraph role="listitem" id="par_id3158410" xml-lang="en-US" l10n="U" oldref="29">If Text1 &gt; Text2 the function returns 1</paragraph>
66</listitem>
67</list>
68<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
69<embed href="text/sbasic/shared/00000003.xhp#err5"/>
70<paragraph role="heading" id="hd_id3153968" xml-lang="en-US" level="2" l10n="U" oldref="18">Example:</paragraph>
71<paragraph role="paragraph" id="par_id3151381" xml-lang="en-US" l10n="U" oldref="19">Sub ExampleStrComp</paragraph>
72<paragraph role="paragraph" id="par_id3154685" xml-lang="en-US" l10n="U" oldref="20">Dim iVar As Single</paragraph>
73<paragraph role="paragraph" id="par_id3148453" xml-lang="en-US" l10n="U" oldref="21">Dim sVar As String</paragraph>
74<paragraph role="paragraph" id="par_id3153369" xml-lang="en-US" l10n="U" oldref="22">iVar = 123.123</paragraph>
75<paragraph role="paragraph" id="par_id3145786" xml-lang="en-US" l10n="U" oldref="23">sVar = Str$(iVar)</paragraph>
76<paragraph role="paragraph" id="par_id3146975" xml-lang="en-US" l10n="U" oldref="24">Msgbox strcomp(sVar , Str$(iVar),1)</paragraph>
77<paragraph role="paragraph" id="par_id3150487" xml-lang="en-US" l10n="U" oldref="25">end sub</paragraph>
78</body>
79</helpdocument>
80