You are here: Foswiki>APPX Web>FullAPIList>0LASubrTextUnicodeComp (10 Apr 2023, BrianRyan)Edit Attach

.TEXT UNICODE COMP

This subroutine compares 2 Unicode fields. Added in 6.0.0


Usage

      PASS         <result>                   FIELD            SHARE? Y
      PASS         <first_string>             FIELD            SHARE? N
      PASS         <second_string>            FIELD            SHARE? N
      GOSUB    --- .TEXT UNICODE COMP
      *        Check for errors
      IF       --- .TEXT UNICODE COMP         NE

Description

This subroutine will do a case insenstive comparison of two Unicode fields and return a result. All parameters are required. If any required parameters are missing, the subroutine will CANCEL.

<result> is a numeric value returned. If a positive number, then <first_string> is greater than <second_string>, if negative then <second_string> is greater than <first_string> and if zero the strings are equal. The comparison is done using Unicode collating sequences. The larger (or smaller) the number, the greater the 'difference'. For example, comparing 'AAA' to 'BBB' results in -1, while comparing 'AAA' to 'zzz' results in -25.

<first_string> is the first string to compare (Required).

<second_string> is the second string to compare (Required).

Note: This subroutine is designed to operate on Alpha, Text, and Token fields only. The returned results are undefined if you specify any other type of field.

Comments


 

-- %USERSIG{JeanNeron - 2017-11-02}%
Topic revision: r3 - 10 Apr 2023, BrianRyan
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback