Programmer's Guide > Interfaces > Application interface > getLocale method
  
getLocale method
Returns the requested locale string.
getLocale( [category] )
Parameters
Stringcategory
null[optional] or a supported locale category string.
On UNIX, this returns the shorter form of the locale name regardless of the value of the category parameter.
On Windows, the following category strings are supported (case sensitive).
category
Method Result
null or empty string
Abbreviated locale string (2-3 letter code). Example: ENU
LC_COLLATE
The locale governing certain collating functions.
LC_CTYPE
The locale governing human-readable messages.
LC_MESSAGES
Equivalent to LC_CTYPE.
LC_MONETARY
The locale governing money formatting.
LC_NUMERIC
The locale governing numeric formatting.
LC_TIME
The locale governing time formatting.
Any other string.
Method will return an empty string.
Returns
String. The requested locale string. Will be null for any unrecognized category string.