Difference between revisions of "Extensions.I18n.GetCurrentLocale"

From emotive
Jump to navigation Jump to search
(Created page with "Category:i18n == Classification == {{ClassificationActivity | GetCurrentLocale | Gets Locale Code | Term | OTX i18n extension | Locale settings related term...")
 
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:i18n]]
+
{{DISPLAYTITLE:  '''GetCurrentLocale'''}}[[Category:i18n]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetCurrentLocale | Gets Locale Code | [[Term]] | [[i18n|OTX i18n extension]] | [[Locale settings related terms ]] | - | - }}
+
{{ClassificationActivity | GetCurrentLocale | Retrieves the current locale code | [[Term]] | [[Extensions.I18n|OTX i18n extension]] | [[Extensions.I18n#Terms|Locale settings related terms ]] | - | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
String GetCurrentLocale();
+
StringTerm I18n.GetCurrentLocale();
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
The '''GetCurrentLocale''' term should retrieve the current locale code that is used by the runtime system. The returned locale code is a combination that consists of a language two-letter code according to ISO 639-1, followed a hyphen and then a country code of two uppercase ISO 3166. Optional can be added (under the direction of another hyphen) a code variant in case of additional adjustments. The Variant codes are not defined in this standard.
+
The '''GetCurrentLocale''' term will retrieve the current locale code that is used by the runtime system. The returned locale code will be a combination of the ISO 639-1 two-letter language code followed by a hyphen, and then the uppercase two letter country code as defined by ISO 3166. Optionally, a variant code may be added in case of additional customizations (headed by another hyphen). The variant codes are not defined by this standard.
  
{{TermReturnValue| [[String]] | Current locale code of the runtime system.}}
+
If no current locale is selected, the system will return the default locale.
 +
 
 +
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Current locale code of the runtime system.}}
  
 
== Properties ==
 
== Properties ==
 +
* NONE
  
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
String result = GetCurrentLocale();
+
/// Local Declarations
 +
 
 +
String String1 = "";
 +
 
 +
/// Flow
 +
 
 +
String1 = I18n.GetCurrentLocale();
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
[[GetAllLocales]]
+
[[Extensions.I18n.GetAllLocales|GetAllLocales]]

Latest revision as of 02:42, 13 September 2019

Classification

Name GetCurrentLocale
Short Description Retrieves the current locale code
Class Term
Extension OTX i18n extension
Group Locale settings related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm I18n.GetCurrentLocale();

Description

The GetCurrentLocale term will retrieve the current locale code that is used by the runtime system. The returned locale code will be a combination of the ISO 639-1 two-letter language code followed by a hyphen, and then the uppercase two letter country code as defined by ISO 3166. Optionally, a variant code may be added in case of additional customizations (headed by another hyphen). The variant codes are not defined by this standard.

If no current locale is selected, the system will return the default locale.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
String Current locale code of the runtime system.

Properties

  • NONE

OTL Examples

/// Local Declarations

String String1 = "";

/// Flow

String1 = I18n.GetCurrentLocale();

See also

GetAllLocales