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="textsbasicshared03120403xml" indexer="include" status="PUBLISH">
34*cdf0e10cSrcweir<title id="tit" xml-lang="en-US">StrComp Function [Runtime]</title>
35*cdf0e10cSrcweir<filename>/text/sbasic/shared/03120403.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-08-24T14:33:33">converted from old format - fpe</lastedited>
40*cdf0e10cSrcweir</history>
41*cdf0e10cSrcweir</meta>
42*cdf0e10cSrcweir<body>
43*cdf0e10cSrcweir<section id="strcomp">
44*cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="index" id="bm_id3156027"><bookmark_value>StrComp function</bookmark_value>
45*cdf0e10cSrcweir</bookmark>
46*cdf0e10cSrcweir<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>
47*cdf0e10cSrcweir<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>
48*cdf0e10cSrcweir</section>
49*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3153345" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
50*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3150503" xml-lang="en-US" l10n="U" oldref="4">StrComp (Text1 As String, Text2 As String[, Compare])</paragraph>
51*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3147574" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
52*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156152" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph>
53*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150984" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameter:</paragraph>
54*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153061" xml-lang="en-US" l10n="U" oldref="8">
55*cdf0e10cSrcweir<emph>Text1:</emph> Any string expression</paragraph>
56*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147560" xml-lang="en-US" l10n="U" oldref="9">
57*cdf0e10cSrcweir<emph>Text2:</emph> Any string expression</paragraph>
58*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3146796" xml-lang="en-US" l10n="U" oldref="10">
59*cdf0e10cSrcweir<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>
60*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3154940" xml-lang="en-US" level="3" l10n="U" oldref="13">Return value</paragraph>
61*cdf0e10cSrcweir<list type="unordered">
62*cdf0e10cSrcweir<listitem>
63*cdf0e10cSrcweir<paragraph role="listitem" id="par_id3150358" xml-lang="en-US" l10n="U" oldref="27">If Text1 &lt; Text2 the function returns -1</paragraph>
64*cdf0e10cSrcweir</listitem>
65*cdf0e10cSrcweir<listitem>
66*cdf0e10cSrcweir<paragraph role="listitem" id="par_id3151043" xml-lang="en-US" l10n="U" oldref="28">If Text1 = Text2 the function returns 0</paragraph>
67*cdf0e10cSrcweir</listitem>
68*cdf0e10cSrcweir<listitem>
69*cdf0e10cSrcweir<paragraph role="listitem" id="par_id3158410" xml-lang="en-US" l10n="U" oldref="29">If Text1 &gt; Text2 the function returns 1</paragraph>
70*cdf0e10cSrcweir</listitem>
71*cdf0e10cSrcweir</list>
72*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
73*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
74*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3153968" xml-lang="en-US" level="2" l10n="U" oldref="18">Example:</paragraph>
75*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3151381" xml-lang="en-US" l10n="U" oldref="19">Sub ExampleStrComp</paragraph>
76*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154685" xml-lang="en-US" l10n="U" oldref="20">Dim iVar As Single</paragraph>
77*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148453" xml-lang="en-US" l10n="U" oldref="21">Dim sVar As String</paragraph>
78*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153369" xml-lang="en-US" l10n="U" oldref="22">iVar = 123.123</paragraph>
79*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3145786" xml-lang="en-US" l10n="U" oldref="23">sVar = Str$(iVar)</paragraph>
80*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3146975" xml-lang="en-US" l10n="U" oldref="24">Msgbox strcomp(sVar , Str$(iVar),1)</paragraph>
81*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3150487" xml-lang="en-US" l10n="U" oldref="25">end sub</paragraph>
82*cdf0e10cSrcweir</body>
83*cdf0e10cSrcweir</helpdocument>
84