1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?> 2cdf0e10cSrcweir 3226a8927SAndrew Rist<!--*********************************************************** 4cdf0e10cSrcweir * 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 12cdf0e10cSrcweir * 13226a8927SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 14cdf0e10cSrcweir * 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. 21cdf0e10cSrcweir * 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"> 3336faf8a5Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3156027"> 3436faf8a5Smseidel<bookmark_value>StrComp function</bookmark_value> 35cdf0e10cSrcweir</bookmark> 36*b488b940Smseidel<paragraph role="heading" id="hd_id3156027" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03120403.xhp" name="StrComp Function [Runtime]">StrComp Function [Runtime]</link></paragraph> 37*b488b940Smseidel<paragraph role="paragraph" id="par_id3155805" xml-lang="en-US" l10n="U">Compares two strings and returns an integer value that represents the result of the comparison.</paragraph> 38cdf0e10cSrcweir</section> 39*b488b940Smseidel<paragraph role="heading" id="hd_id3153345" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph> 40*b488b940Smseidel<paragraph role="paragraph" id="par_id3150503" xml-lang="en-US" l10n="U">StrComp (Text1 As String, Text2 As String[, Compare])</paragraph> 41*b488b940Smseidel<paragraph role="heading" id="hd_id3147574" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph> 42*b488b940Smseidel<paragraph role="paragraph" id="par_id3156152" xml-lang="en-US" l10n="U">Integer</paragraph> 43*b488b940Smseidel<paragraph role="heading" id="hd_id3150984" xml-lang="en-US" level="2" l10n="U">Parameter:</paragraph> 44*b488b940Smseidel<paragraph role="paragraph" id="par_id3153061" xml-lang="en-US" l10n="U"><emph>Text1:</emph> Any string expression</paragraph> 45*b488b940Smseidel<paragraph role="paragraph" id="par_id3147560" xml-lang="en-US" l10n="U"><emph>Text2:</emph> Any string expression</paragraph> 46*b488b940Smseidel<paragraph role="paragraph" id="par_id3146796" xml-lang="en-US" l10n="U"><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> 47*b488b940Smseidel<paragraph role="heading" id="hd_id3154940" xml-lang="en-US" level="3" l10n="U">Return value</paragraph> 48cdf0e10cSrcweir<list type="unordered"> 49cdf0e10cSrcweir<listitem> 50*b488b940Smseidel<paragraph role="listitem" id="par_id3150358" xml-lang="en-US" l10n="U">If Text1 < Text2 the function returns -1</paragraph> 51cdf0e10cSrcweir</listitem> 52cdf0e10cSrcweir<listitem> 53*b488b940Smseidel<paragraph role="listitem" id="par_id3151043" xml-lang="en-US" l10n="U">If Text1 = Text2 the function returns 0</paragraph> 54cdf0e10cSrcweir</listitem> 55cdf0e10cSrcweir<listitem> 56*b488b940Smseidel<paragraph role="listitem" id="par_id3158410" xml-lang="en-US" l10n="U">If Text1 > Text2 the function returns 1</paragraph> 57cdf0e10cSrcweir</listitem> 58cdf0e10cSrcweir</list> 59cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> 60cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/> 61*b488b940Smseidel<paragraph role="heading" id="hd_id3153968" xml-lang="en-US" level="2" l10n="U">Example:</paragraph> 62*b488b940Smseidel<paragraph role="paragraph" id="par_id3151381" xml-lang="en-US" l10n="U">Sub ExampleStrComp</paragraph> 63*b488b940Smseidel<paragraph role="paragraph" id="par_id3154685" xml-lang="en-US" l10n="U">Dim iVar As Single</paragraph> 64*b488b940Smseidel<paragraph role="paragraph" id="par_id3148453" xml-lang="en-US" l10n="U">Dim sVar As String</paragraph> 65*b488b940Smseidel<paragraph role="paragraph" id="par_id3153369" xml-lang="en-US" l10n="U">iVar = 123.123</paragraph> 66*b488b940Smseidel<paragraph role="paragraph" id="par_id3145786" xml-lang="en-US" l10n="U">sVar = Str$(iVar)</paragraph> 67*b488b940Smseidel<paragraph role="paragraph" id="par_id3146975" xml-lang="en-US" l10n="U">Msgbox strcomp(sVar , Str$(iVar),1)</paragraph> 68*b488b940Smseidel<paragraph role="paragraph" id="par_id3150487" xml-lang="en-US" l10n="U">end sub</paragraph> 69cdf0e10cSrcweir</body> 70cdf0e10cSrcweir</helpdocument> 71