Difference between revisions of "Os.setlocale"
From GiderosMobile
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
| + | '''Class:''' [[os]]<br/> | ||
| + | |||
=== 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" | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | (string) = os.setlocale(locale,category) | ||
| + | </syntaxhighlight> | ||
| + | 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 === | === Parameters === | ||
| − | '''locale''': (string) | + | '''locale''': (string) locale to set<br/> |
| − | '''category''': (string) | + | '''category''': (string) category to change '''optional'''<br/> |
| + | |||
=== Return values === | === Return values === | ||
| − | '''Returns''' (string) | + | '''Returns''' (string) name if current locale<br/> |
| + | |||
| + | {{Os}} | ||
Latest revision as of 22:23, 14 October 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"
(string) = os.setlocale(locale,category)
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
