summaryrefslogtreecommitdiffstats
path: root/helpcontent2/source/text/sbasic/shared/03120403.xhp
blob: 6551e263d96ae85b7b36871e9f7aff6f354e1ca4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->

<meta>
  <topic id="textsbasicshared03120403xml" indexer="include" status="PUBLISH">
    <title id="tit" xml-lang="en-US">StrComp Function</title>
    <filename>/text/sbasic/shared/03120403.xhp</filename>
  </topic>
</meta>

<body>


<section id="strcomp">
<bookmark xml-lang="en-US" branch="index" id="bm_id3156027">
  <bookmark_value>StrComp function</bookmark_value>
</bookmark>


<paragraph id="hd_id3156027" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120403.xhp" name="StrComp Function">StrComp Function</link></paragraph>
<paragraph id="par_id3155805" role="paragraph" xml-lang="en-US">Compares two strings and returns an integer value that represents the result of the comparison.</paragraph>
</section>

<paragraph id="hd_id3153345" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
<bascode>
<paragraph id="par_id3150503" role="bascode" xml-lang="en-US">StrComp (Text1 As String, Text2 As String[, Compare])</paragraph>
</bascode>

<paragraph id="hd_id3147574" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
<paragraph id="par_id3156152" localize="false" role="paragraph">Integer</paragraph>

<paragraph id="hd_id3150984" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph>
<paragraph id="par_id3153061" role="paragraph" xml-lang="en-US"> <emph>Text1:</emph> Any string expression</paragraph>
<paragraph id="par_id3147560" role="paragraph" xml-lang="en-US"> <emph>Text2:</emph> Any string expression</paragraph>
<paragraph id="par_id3146796" role="paragraph" xml-lang="en-US"> <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>

<paragraph id="hd_id3154940" role="heading" level="3" xml-lang="en-US">Return value</paragraph>

<list type="unordered">
  <listitem>
    <paragraph id="par_id3150358" role="listitem" xml-lang="en-US">If Text1 &lt; Text2 the function returns -1</paragraph>
  </listitem>
  <listitem>
    <paragraph id="par_id3151043" role="listitem" xml-lang="en-US">If Text1 = Text2 the function returns 0</paragraph>
  </listitem>
  <listitem>
    <paragraph id="par_id3158410" role="listitem" xml-lang="en-US">If Text1 &gt; Text2 the function returns 1</paragraph>
  </listitem></list>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>

<paragraph id="hd_id3153968" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
<bascode>
<paragraph id="par_idm1341100656" role="bascode" localize="false" xml-lang="en-US">Sub ExampleStrComp</paragraph>
<paragraph id="par_idm1341099424" role="bascode" localize="false" xml-lang="en-US">Dim iVar As Single</paragraph>
<paragraph id="par_idm1341098192" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph>
<paragraph id="par_idm1341096960" role="bascode" localize="false" xml-lang="en-US">    iVar = 123.123</paragraph>
<paragraph id="par_idm1341095728" role="bascode" localize="false" xml-lang="en-US">    sVar = Str$(iVar)</paragraph>
<paragraph id="par_idm1341094496" role="bascode" localize="false" xml-lang="en-US">    MsgBox strcomp(sVar , Str$(iVar),1)</paragraph>
<paragraph id="par_idm1341093248" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>

</helpdocument>