Difference between revisions of "Extensions.I18n.GetCurrentLocale"

From emotive
Jump to navigation Jump to search
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 | Gets Locale Code | [[Term]] | [[Extensions.I18n|OTX i18n extension]] | [[Locale settings related terms ]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 11: Line 11:
 
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 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.
  
{{TermReturnValue| [[String]] | Current locale code of the runtime system.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Current locale code of the runtime system.}}
  
 
== Properties ==
 
== Properties ==
Line 22: Line 22:
  
 
== See also ==
 
== See also ==
[[GetAllLocales]]
+
[[Extensions.I18n.GetAllLocales|GetAllLocales]]

Revision as of 09:34, 15 February 2016

Classification

Name GetCurrentLocale
Short Description Gets 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 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.

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

OTL Examples

String result;
result = I18n.GetCurrentLocale();

See also

GetAllLocales