variant_cmp

Compares two variants

&reftitle.description; `int` `variant_cmp` `mixed` `left` `mixed` `right` `int` `locale_id` `LOCALE_SYSTEM_DEFAULT` `int` `flags` 0

Compares `left` with `right`.

This function will only compare scalar values, not arrays or variant records.

&reftitle.parameters;

`left`

- The left operand.

`right`

- The right operand.

`locale_id`

- A valid Locale Identifier to use when comparing strings (this affects string collation).

`flags`

- `flags` can be one or more of the following values OR'd together, and affects string comparisons:

  ## Variant Comparision Flags

  value | meaning
  `NORM_IGNORECASE` | Compare case insensitively
  `NORM_IGNORENONSPACE` | Ignore nonspacing characters
  `NORM_IGNORESYMBOLS` | Ignore symbols
  `NORM_IGNOREWIDTH` | Ignore string width
  `NORM_IGNOREKANATYPE` | Ignore Kana type
  `NORM_IGNOREKASHIDA` | Ignore Arabic kashida characters

&com.variant-arith;
&reftitle.returnvalues;

Returns one of the following:

## Variant Comparision Results

value | meaning
`VARCMP_LT` | `left` is less than `right`
`VARCMP_EQ` | `left` is equal to `right`
`VARCMP_GT` | `left` is greater than `right`
`VARCMP_NULL` | Either `left`, `right` or both are &null;