Difference between revisions of "Os.setlocale"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
Line 5: Line 5:
 
=== Description ===
 
=== Description ===
 
Sets the current locale of the program. ''locale'' is a string specifying a locale; ''category'' is an optional string describing which category to change: "all", "collate", "ctype", "monetary", "numeric", or "time"; the default category is "all".
 
Sets the current locale of the program. ''locale'' is a string specifying a locale; ''category'' is an optional string describing which category to change: "all", "collate", "ctype", "monetary", "numeric", or "time"; the default category is "all".
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(string) = os.setlocale(locale,category)
 
(string) = os.setlocale(locale,category)
 
</source>
 
</source>

Revision as of 15:30, 13 July 2023

Available since: Gideros 2011.6
Class: os

Description

Sets the current locale of the program. locale is a string specifying a locale; category is an optional string describing which category to change: "all", "collate", "ctype", "monetary", "numeric", or "time"; the default category is "all". <syntaxhighlight lang="lua"> (string) = os.setlocale(locale,category) </source>

The function returns the name of the new locale, or nil if the request cannot be honored.

If locale is the empty string, the current locale is set to an implementation-defined native locale. If locale is the string "C", the current locale is set to the standard C locale.
When called with nil as the first argument, this function only returns the name of the current locale for the given category.

Parameters

locale: (string) locale to set
category: (string) category to change optional

Return values

Returns (string) name if current locale