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