win.CompareString

LuaFAR 3

win.CompareString


result = win.CompareString(s1, s2, [locale], [flags])

Parameters:
  s1     : string
  s2     : string
  locale : string, or nil (default="u")
             either of:
               "s" (system default)
               "u" (user default)
               "n" (neutral)
  flags  : string, or nil (default="")
             any combination of characters:
               'c' =  NORM_IGNORECASE;
               'k' =  NORM_IGNOREKANATYPE;
               'n' =  NORM_IGNORENONSPACE;
               's' =  NORM_IGNORESYMBOLS;
               'w' =  NORM_IGNOREWIDTH;
               'S' =  SORT_STRINGSORT;

Returns:
  result : integer (either of -1, 0, 1), or nil

Note:
  The underlying function CompareStringW seems to behave as if
  flag NORM_IGNORECASE is always present, even if it is not.

Windows API used:
  CompareStringW