Get_Locale¶

Include: Use System\Locale.pkg

See Also: Locale constants, Set_Locale, Push_Locale, Pop_Locale

Purpose¶

Reads the active program locale name.

Syntax¶

Get_Locale to sLocale
Get_Locale sLocale

Arguments¶

sLocale : Receives the current locale name string.

Returns¶

None.

Behavior¶

Get_Locale reads the active DF_LOCALE attribute into sLocale. A non-string destination is a compile-time command error.

The returned value is the active locale identifier assembled from the current locale language, country, and script attributes. After the locale has been customized, the returned value is not required to be one of the built-in constant names.

Example¶

Use System\Locale.pkg

String sLocale
Get_Locale to sLocale