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