compareGtr

compareGtr(rhs:         String;
           bIgnoreCase: Boolean;
           bUseLocale:  Boolean;
           locale:      Locale): Boolean;

The compareGtr method of the String primitive type returns true if the receiver is greater than the value of the rhs parameter; otherwise, it returns false.

Parameters enable you to make the comparison case-sensitive or case-insensitive, and to use the sort order associated with a locale or the strict binary sort order. (These are the same comparison options that you can specify on dictionary keys.)

The relational binary comparison operator (>), documented in Chapter 1 of the JADE Developer’s Reference, uses a strict binary value comparison.

If the value of the bIgnoreCase parameter is false:

A strict binary value comparison is performed if the value of the bUseLocale parameter is also false.
A case-sensitive comparison using the sort order of the current locale of the process is performed if the value of the bUseLocale parameter is true and the value of the locale parameter is null.
A case-sensitive comparison using the specified locale is performed if the value of the bUseLocale parameter is true and the value of the locale parameter is not null.

If the value of the bIgnoreCase parameter is true:

A case-insensitive binary value comparison for characters less than Decimal 254 is performed; for example, the first of the following code fragments is equivalent to the second code fragment.
```
recv.compareGtr(lhs, true, false, null);

recv.toLower > lhs.toLower;
```
A case-insensitive comparison using the sort order of the current locale of the process is performed if the value of the bUseLocale parameter is true and the value of the locale parameter is null.
A case-insensitive comparison using the specified locale is performed if the value of the bUseLocale parameter is true and the value of the locale parameter is not null.

The code fragment in the following example shows the use of the compareGtr method.

vars
    locale : Locale;
begin
    write "alice".compareGtr("carol", false, false, null);  // Outputs false
    write "bob".compareGtr("bob", false, false, null);      // Outputs false
    write "carol".compareGtr("alice", false, false, null);  // Outputs true
// Comparisons with accented characters using binary and locale sort orders
    locale := currentSchema.getLocale("5129");
    write "àcute".compareGtr("zebra", false, false, null);  // Outputs true
    write "àcute".compareGtr("zebra", false, true, locale); // Outputs false