Useful constant for en_CA.

Since :

2.3.1

Useful constant for fr_CA.

Since :

2.3.1

Useful constant for zh_CN.

Since :

2.3.1

Useful constant for zh.

Since :

2.3.1

Useful constant for the maximum size of the country part of a locale ID (including the terminating NULL).

Since :

3.0

See also:

i18n_ulocale_get_keyword_value()

i18n_ulocale_get_country()

Useful constant for en.

Since :

2.3.1

Useful constant for fr_FR.

Since :

2.3.1

Useful constant for fr.

Since :

2.3.1

Useful constant for the maximum size of the whole locale ID (including the terminating NULL and all keywords).

Since :

3.0

See also:

i18n_ulocale_get_keyword_value()

Useful constant for de.

Since :

2.3.1

Useful constant for de_DE.

Since :

2.3.1

Useful constant for it.

Since :

2.3.1

Useful constant for it_IT.

Since :

2.3.1

Useful constant for ja_JP.

Since :

2.3.1

Useful constant for ja.

Since :

2.3.1

Useful constant for the maximum total size of keywords and their values in a locale.

Since :

3.0

See also:

i18n_ulocale_get_keyword_value()

Invariant character for assigning value to a keyword.

Since :

3.0

See also:

i18n_ulocale_get_keyword_value()

Unicode code point for '=' for assigning value to a keyword.

Since :

3.0

See also:

I18N_ULOCALE_KEYWORD_ASSIGN

i18n_ulocale_get_keyword_value()

Invariant character separating keywords.

Since :

3.0

See also:

i18n_ulocale_get_keyword_value()

Unicode code point for ';' separating keywords.

Since :

3.0

See also:

I18N_ULOCALE_KEYWORD_ITEM_SEPARATOR

i18n_ulocale_get_keyword_value()

Invariant character separating keywords from the locale string.

Since :

3.0

See also:

i18n_ulocale_get_keyword_value()

Unicode code point for '@' separating keywords from the locale string.

Since :

3.0

See also:

I18N_ULOCALE_KEYWORD_SEPARATOR

i18n_ulocale_get_keyword_value()

Useful constant for the maximum size of keywords in a locale.

Since :

3.0

See also:

i18n_ulocale_get_keyword_value()

Useful constant for ko_KR.

Since :

2.3.1

Useful constant for ko.

Since :

2.3.1

Useful constant for the maximum size of the language part of a locale ID. (including the terminating NULL).

Since :

3.0

See also:

i18n_ulocale_get_keyword_value()

i18n_ulocale_get_language()

Useful constant for zh_CN.

Since :

2.3.1

Useful constant for the maximum size of the script part of a locale ID (including the terminating NULL).

Since :

3.0

See also:

i18n_ulocale_get_keyword_value()

i18n_ulocale_get_script()

Useful constant for zh_CN.

Since :

2.3.1

Useful constant for zh_TW.

Since :

2.3.1

Useful constant for zh_TW.

Since :

2.3.1

Useful constant for en_GB.

Since :

2.3.1

Useful constant for en_US.

Since :

2.3.1

Enumeration for the 'out_result' parameter return value.

Since :

2.3.1

See also:

i18n_ulocale_accept_language_from_http()

i18n_ulocale_accept_language()

Enumerator:

I18N_ULOCALE_ACCEPT_FAILED	No exact match was found
I18N_ULOCALE_ACCEPT_VALID	An exact match was found
I18N_ULOCALE_ACCEPT_FALLBACK	A fallback was found, for example, accept list contained 'ja_JP' which matched available locale 'ja'

Enumeration for data locale types.

Since :

2.3.1

Enumerator:

I18N_ULOCALE_DATA_LOCALE_TYPE_ACTUAL_LOCALE	Actual locale
I18N_ULOCALE_DATA_LOCALE_TYPE_VALID_LOCALE	Valid locale
I18N_ULOCALE_DATA_LOCALE_TYPE_LIMIT	Locale type limit

Enumeration for the return value for the character and line orientation functions.

Since :

2.3.1

Enumerator:

I18N_ULOCALE_LAYOUT_LTR	Left-to-right
I18N_ULOCALE_LAYOUT_RTL	Right-to-left
I18N_ULOCALE_LAYOUT_TTB	Top-to-bottom
I18N_ULOCALE_LAYOUT_BTT	Bottom-to-top
I18N_ULOCALE_LAYOUT_UNKNOWN	Unknown

Adds the likely subtags for a provided locale ID, per the algorithm described in the following CLDR technical report : http://www.unicode.org/reports/tr35/#Likely_Subtags.

If locale_id is already in the maximal form, or there is no data available for maximization, it will be copied to the output buffer. For example, "und-Zzzz" cannot be maximized, since there is no reasonable maximization.

Examples :

"en" maximizes to "en_Latn_US"

"de" maximizes to "de_Latn_US"

"sr" maximizes to "sr_Cyrl_RS"

"sh" maximizes to "sr_Latn_RS" (Note this will not reverse.)

"zh_Hani" maximizes to "zh_Hans_CN" (Note this will not reverse.)

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	The locale to maximize
[out]	maximized_locale_id	The maximized locale
[in]	maximized_locale_id_capacity	The capacity of the maximized_locale_id buffer

Returns:

The actual buffer size needed for the maximized locale. If it's greater than maximized_lacale_id_capacity, the returned ID will be truncated. On error, the return value is -1.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the full name for the specified locale.

Note : This has the effect of 'canonicalizing' the string to a certain extent. Upper and lower case are set as needed, and if the components were in 'POSIX' format they are changed to I18N format. It does NOT map aliased names in any way. See the top of this header file.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	The locale to get the full name with
[out]	name	The full name for locale_id
[in]	name_capacity	The size of the name buffer to store the full name with

Returns:

The actual buffer size needed for the full name. If it's greater than name_capacity, the returned full name will be truncated.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_BUFFER_OVERFLOW	A result would not fit in the supplied buffer

Gets the size of the all available locale list.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section.

Since :

2.3.1

Returns:

The size of the locale list

Exceptions:

I18N_ERROR_NONE

Success

Returns a locale ID for the specified BCP47 language tag string.

If the specified language tag contains any ill-formed subtags, the first such subtag and all following subtags are ignored.

This implements the 'Language-Tag' production of BCP47, and so supports grandfathered (regular and irregular) as well as private use language tags. Private use tags are represented as 'x-whatever', and grandfathered tags are converted to their canonical replacements where they exist. Note that a few grandfathered tags have no modern replacement, these will be converted using the fallback described in the first paragraph, so some information might be lost.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	langtag	The input BCP47 language tag.
[out]	locale_id	The output buffer receiving a locale ID for the specified BCP47 language tag.
[in]	locale_id_capacity	The size of the locale_id output buffer.
[in]	parsed_length	If not NULL, successfully parsed length for the input language tag is set.

Returns:

The length of the locale ID. If the langtag or locale_id buffer is NULL or the locale_id_capacity is lower than 0, then the I18N_ERROR_INVALID_PARAMETER error will be set and -1 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the specified locale from a list of all available locales.

The return value is a pointer to an item of a locale name array. Both this array and the pointers it contains are owned by I18N and should not be deleted or written through by the caller. The locale name is terminated by a null pointer.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section.

Since :

2.3.1

Parameters:

[in]

n

The specific locale name index of the available locale list

Returns:

A specified locale name of all available locales

Exceptions:

I18N_ERROR_NONE	Success
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the full name for the specified locale, like i18n_ulocale_get_name(), but without keywords.

Note : This has the effect of 'canonicalizing' the string to a certain extent. Upper and lower case are set as needed, and if the components were in 'POSIX' format they are changed to I18N format. It does NOT map aliased names in any way. See the top of this header file.

This API strips off the keyword part, so "de_DE\@collation=phonebook" will become "de_DE". This API supports preflighting.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	The locale to get the full name with
[out]	name	Fill in buffer for the name without keywords.
[in]	name_capacity	Capacity of the fill in buffer.

Returns:

The actual buffer size needed for the full name. If it's greater than name_capacity, the returned full name will be truncated.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_BUFFER_OVERFLOW	A result would not fit in the supplied buffer

Gets the layout character orientation for the specified locale.

Remarks:

Error codes are described in i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	locale name
[out]	layout_type	A pointer to the enum indicating the layout orientation for characters.

Returns:

The obtained error code.

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the country code for the specified locale.

Since :

2.3.1

Parameters:

[in]	locale_id	The locale to get the country code with
[out]	country	The country code for locale_id
[in]	country_capacity	The size of the country buffer to store the country code with
[out]	error	Error information if retrieving the country code failed

Returns:

The actual buffer size needed for the country code.
If it's greater than country_capacity, the returned country code will be truncated.

Gets I18N's default locale.

The returned string is a snapshot in time, and will remain valid and unchanged even when i18n_ulocale_set_default() is called. The returned storage is owned by I18N, and must not be altered or deleted by the caller.

Since :

2.3.1

Parameters:

[out]

locale

The I18N default locale

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the country name suitable for display for the specified locale.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale	The locale to get the displayable country code with. NULL may be used to specify the default.
[in]	display_locale	The locale to be used to display the name. NULL may be used to specify the default.
[out]	country	The displayable country code for locale
[in]	country_capacity	The size of the country buffer to store the displayable country code with

Returns:

The actual buffer size needed for the displayable country code. If it's greater than country_capacity, the returned displayable country code will be truncated. If the country buffer is NULL or the country_capacity is lower than 0 , then the I18N_ERROR_INVALID_PARAMETER error will be set and 0 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the keyword name suitable for display for the specified locale.

E.g : for the locale string de_DE@collation=PHONEBOOK, this API gets the display string for the keyword collation. Usage :

      i18n_error_code_e status = I18N_ERROR_NONE;
      const char* keyword = NULL;
      int32_t keyword_len = 0;
      int32_t keyword_count = 0;
      i18n_uchar display_keyword[256];
      int32_t display_keyword_len = 0;
      i18n_uenumeration_h keyword_enum;
      i18n_ulocale_keywords_create("en_US@collation=PHONEBOOK;calendar=TRADITIONAL", &keyword_enum);

      for(keyword_count = i18n_uenumeration_count(keyword_enum); keyword_count > 0; keyword_count--){
            status = get_last_result();
            if(status > 0){
                // something went wrong so handle the error
                break;
            }
            // the uenum_next returns NULL-terminated string
            keyword = i18n_uenumeration_next(keyword_enum, &keyword_len);
            display_keyword_len = i18n_ulocale_get_display_keyword(keyword, "en_US", display_keyword, 256);
            // do something interesting
      }
      i18n_uenumeration_destroy(keyword_enum);

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	keyword	The keyword whose display string needs to be returned.
[in]	display_locale	The locale to be used to display the name. NULL may be used to specify the default.
[out]	dest	The buffer to which the displayable keyword should be written.
[in]	dest_capacity	The size of the buffer (number of i18n_uchar characters). If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string (pre-flighting).

Returns:

The actual buffer size needed for the displayable variant code. If the dest buffer is NULL or the dest_capacity is lower than 0 , then the I18N_ERROR_INVALID_PARAMETER error will be set and 0 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

See also:

i18n_ulocale_keywords_create()

i18n_uenumeration_count()

i18n_uenumeration_next()

i18n_uenumeration_destroy()

Gets the value of the keyword suitable for display for the specified locale.

E.g : for the locale string de_DE@collation=PHONEBOOK, this API gets the display string for PHONEBOOK, in the display locale, when "collation" is specified as the keyword.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale	The locale to get the displayable variant code with. NULL may be used to specify the default.
[in]	keyword	The keyword for whose value should be used.
[in]	display_locale	The locale to be used to display the name. NULL may be used to specify the default.
[out]	dest	The buffer to which the displayable keyword should be written.
[in]	dest_capacity	The size of the buffer (number of i18n_uchar characters). If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string (pre-flighting).

Returns:

The actual buffer size needed for the displayable variant code. If the dest buffer is NULL or the dest_capacity is lower than 0 , then the I18N_ERROR_INVALID_PARAMETER error will be set and 0 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the language name suitable for display for the specified locale.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale	The locale to get the ISO language code with
[in]	display_locale	The locale to be used to display the name. NULL may be used to specify the default.
[out]	language	The displayable language code for locale.
[in]	language_capacity	The size of the language buffer to store the displayable language code with

Returns:

The actual buffer size needed for the displayable language code. If it's greater than language_capacity, the returned language code will be truncated. If the language buffer is NULL or the language_capacity is lower than 0 , then the I18N_ERROR_INVALID_PARAMETER error will be set and 0 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the full name suitable for display for the specified locale.

Since :

2.3.1

Parameters:

[in]	locale_id	The locale to get the displayable name with. NULL may be used to specify the default.
[in]	in_locale_id	The locale to be used to display the name. NULL may be used to specify the default.
[out]	result	The displayable name for locale_id
[in]	max_result_size	The size of the name buffer to store the displayable full name with
[out]	buf_size_display_name	The actual buffer size needed for the displayable name. If it's greater than max_result_size, the returned displayable name will be truncated.

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the script name suitable for display for the specified locale.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale	The locale to get the displayable script code with. NULL may be used to specify the default.
[in]	display_locale	The locale to be used to display the name. NULL may be used to specify the default.
[out]	script	The displayable country code for locale
[in]	script_capacity	The size of the script buffer to store the displayable script code with

Returns:

The actual buffer size needed for the displayable script code. If it's greater than script_capacity, the returned displayable script code will be truncated. If the script buffer is NULL or the script_capacity is lower than 0 , then the I18N_ERROR_INVALID_PARAMETER error will be set and 0 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the variant name suitable for display for the specified locale.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale	The locale to get the displayable variant code with. NULL may be used to specify the default.
[in]	display_locale	The locale to be used to display the name. NULL may be used to specify the default.
[out]	variant	The displayable variant code for locale
[in]	variant_capacity	The size of the variant buffer to store the displayable variant code with

Returns:

The actual buffer size needed for the displayable variant code. If it's greater than variant_capacity, the returned displayable variant code will be truncated. If the variant buffer is NULL or the variant_capacity is lower than 0 , then the I18N_ERROR_INVALID_PARAMETER error will be set and 0 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the ISO country code for the specified locale.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section.

Since :

2.3.1

Parameters:

[in]

locale_id

The locale to get the ISO country code with

Returns:

A country the ISO country code for locale_id

Exceptions:

I18N_ERROR_NONE

Successful

Gets the ISO language code for the specified locale.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section.

Since :

2.3.1

Parameters:

[in]

locale_id

The locale to get the ISO language code with

Returns:

A language the ISO language code for locale_id

Exceptions:

I18N_ERROR_NONE

Successful

Gets a list of all available 2-letter country codes defined in ISO 639.

This is a pointer to an array of pointers to arrays of char. All of these pointers are owned by I18N - do not delete them, and do not write through them. The array is terminated with a NULL pointer.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section.

Since :

2.3.1

Returns:

A list of all available country codes

Exceptions:

I18N_ERROR_NONE

Successful

Gets a list of all available 2-letter language codes defined in ISO 639, plus additional 3-letter codes determined to be useful for locale generation as defined by Unicode CLDR.

This is a pointer to an array of pointers to arrays of char. All of these pointers are owned by I18N - do not delete them, and do not write through them. The array is terminated with a NULL pointer.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section.

Since :

2.3.1

Returns:

A list of all available language codes

Exceptions:

I18N_ERROR_NONE

Successful

Gets the value for a keyword.

Locale name does not need to be normalized.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	A locale name containing the keyword ("de_DE@currency=EURO;collation=PHONEBOOK")
[in]	keyword_name	The name of the keyword for which we want the value. Case insensitive.
[out]	buffer	Receiving buffer
[in]	buffer_capacity	Capacity of receiving buffer

Returns:

The length of keyword value. If the keyword_name or buffer is NULL or the buffer_capacity is lower than 0, then the I18N_ERROR_INVALID_PARAMETER error will be set and -1 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the language code for the specified locale.

Since :

2.3.1

Parameters:

[in]	locale_id	The locale to get the ISO language code with. NULL may be used to specify the default.
[out]	language	The language code for locale_id
[in]	language_capacity	The size of the language buffer to store the language code with
[out]	buf_size_language	The actual buffer size needed for the language code. If it's greater than language_capacity, the returned language code will be truncated.

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the Win32 LCID value for the specified locale.

If the I18N locale is not recognized by Windows, 0 will be returned.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section.

Since :

2.3.1

Parameters:

[in]

locale_id

The locale to get the Win32 LCID value with

Returns:

A country the Win32 LCID for locale_id

Exceptions:

I18N_ERROR_NONE

Successful

Gets the layout line orientation for the specified locale.

Remarks:

Error codes are described in i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	locale name
[out]	layout_type	A pointer to the enum indicating the layout orientation for lines.

Returns:

The obtained error code.

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the I18N locale ID for the specified Win32 LCID value.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	host_id	The Win32 LCID to translate
[out]	locale	The output buffer for the I18N locale ID, which will be NULL-terminated if there is room.
[in]	locale_capacity	The size of the output buffer

Returns:

The actual size of the locale ID, not including NULL-termination. If the locale buffer is NULL or the locale_capacity is lower than 0, then the I18N_ERROR_INVALID_PARAMETER error will be set and -1 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the full name for the specified locale.

Note : This has the effect of 'canonicalizing' the I18N locale ID to a certain extent. Upper and lower case are set as needed. It does NOT map aliased names in any way. See the top of this header file. This API supports preflighting.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	The locale to get the full name with
[out]	name	Fill in buffer for the name without keywords.
[in]	name_capacity	Capacity of the fill in buffer.

Returns:

The actual buffer size needed for the full name. If it's greater than name_capacity, the returned full name will be truncated.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_BUFFER_OVERFLOW	A result would not fit in the supplied buffer

Truncates the locale ID string to get the parent locale ID.

Copies the part of the string before the last underscore. The parent locale ID will be an empty string if there is no underscore, or if there is only one underscore at locale_id[0].

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	Input locale ID string.
[out]	parent	Output string buffer for the parent locale ID. Must not be NULL.
[in]	parent_capacity	Size of the output buffer. If it's lower than the number of characters stored in the locale_id between the first character and the last occurrence of the underscore ("_") character, than the error code will be set to I18N_ERROR_BUFFER_OVERFLOW.

Returns:

The length of the parent locale ID. If the parent buffer is NULL or the parent_capacity is lower than 0, then the I18N_ERROR_INVALID_PARAMETER error will be set and -1 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter
I18N_ERROR_BUFFER_OVERFLOW	If the capacity of the parent is lower than the number of characters in the locale_id from index 0 to the index of the last occurrence of the underscore ("_") symbol.

Gets the script code for the specified locale.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	The locale to get the ISO script code with
[out]	script	The script code for locale_id. Must not be NULL.
[in]	script_capacity	The size of the script buffer to store the script code with

Returns:

The actual buffer size needed for the script code. If it's greater than script_capacity, the returned script code will be truncated. If the script buffer is NULL or the script_capacity is lower than 0 , then the I18N_ERROR_INVALID_PARAMETER error will be set and -1 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets the variant code for the specified locale.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	The locale to get the variant code with
[out]	variant	The variant code for locale_id
[in]	variant_capacity	The size of the variant buffer to store the variant code with

Returns:

The actual buffer size needed for the variant code. If it's greater than variant_capacity, the returned variant code will be truncated. If the variant buffer is NULL or the variant_capacity is lower than 0 , then the I18N_ERROR_INVALID_PARAMETER error will be set and -1 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Gets an enumeration of keywords for the specified locale.

Enumeration must get disposed of by the client using i18n_uenumeration_destroy() function.

Remarks:

Error codes are described in i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	The locale to get the variant code with
	enumeration	A pointer to the enumeration of keywords or NULL if there are no keywords.

Returns:

The obtained error code.

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Minimizes the subtags for a provided locale ID, per the algorithm described in the following CLDR technical report: http://www.unicode.org/reports/tr35/#Likely_Subtags.

If locale_id is already in the minimal form, or there is no data available for minimization, it will be copied to the output buffer. Since the minimization algorithm relies on proper maximization, see the comments for i18n_ulocale_add_likely_subtags() for reasons why there might not be any data.

Examples :

"en_Latn_US" minimizes to "en"

"de_Latn_US" minimizes to "de"

"sr_Cyrl_RS" minimizes to "sr"

"zh_Hant_TW" minimizes to "zh_TW" (The region is preferred to the script, and minimizing to "zh" would imply "zh_Hans_CN".)

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	The locale to minimize
[out]	minimized_locale_id	The minimized locale
[in]	minimized_locale_id_capacity	The capacity of the minimized_locale_id buffer

Returns:

The actual buffer size needed for the minimized locale. If it's greater than minimized_locale_id_capacity, the returned ID will be truncated. On error, the return value is -1.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Sets I18N's default locale.

By default (without calling this function), I18N's default locale will be based on information obtained from the underlying system environment.

Changes to I18N's default locale do not propagate back to the system environment.

Changes to I18N's default locale to not affect any services that may already be open based on the previous default locale value.

Since :

2.3.1

Parameters:

[in]

locale_id

The new I18N default locale. A value of NULL will try to get the system's default locale.

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

Sets or removes the value of the specified keyword.

For removing all keywords(retrieving only locale base name associated with the keywords), use i18n_ulocale_get_base_name().

NOTE : Unlike almost every other I18N function which takes a buffer, this function will NOT truncate the output text. If a I18N_ERROR_BUFFER_OVERFLOW is received, it means that the original buffer is untouched. This is done to prevent incorrect or possibly even malformed locales from being generated and used.

Below code prints following logs in SDK:

Locale and keywords: en_US@abc=12;def=34
keyword1: abc
keyword2: def
Locale: en_US
Keyword1 value: 12

      int32_t buff_size = 50;
      int32_t sub_buff_size = 45;
      char *buff = malloc(sizeof(char)*buff_size);
      char *sub_buff = malloc(sizeof(char)*sub_buff_size);
      char *locale = "en_US";

      snprintf(buff, buff_size, "%s%s",locale, sub_buff);

      i18n_ulocale_set_keyword_value("abc", "cba", buff, buff_size);
      i18n_ulocale_set_keyword_value("def", "34", buff, buff_size);

      i18n_uenumeration_h keyword_enum;
      i18n_ulocale_keywords_create(buff, &keyword_enum);

      int32_t res_len = 0;
      const char *keyw = i18n_uenumeration_next(keyword_enum, &res_len);
      const char *keyw2 = i18n_uenumeration_next(keyword_enum, &res_len);

      char *only_locale = malloc(sizeof(char)*10);
      i18n_ulocale_get_base_name(buff, only_locale, 10);

      int32_t buff_size_get = 50;
      char *buff_out = malloc(sizeof(char)*buff_size_get);
      i18n_ulocale_get_keyword_value(buff, "abc", buff_out, buff_size_get);

      dlog_print(DLOG_DEBUG, "test", "Locale and keywords: %s", buff);
      dlog_print(DLOG_DEBUG, "test", "keyword1: %s", keyw);
      dlog_print(DLOG_DEBUG, "test", "keyword2: %s", keyw2);
      dlog_print(DLOG_DEBUG, "test", "Locale: %s", only_locale);
      dlog_print(DLOG_DEBUG, "test", "Keyword1 value: %s", buff_out);

      i18n_uenumeration_destroy(keyword_enum)
      free(buff);
      free(sub_buff);
      free(only_locale);
      free(buff_out);

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	keyword_name	A name of the keyword to be set. Case insensitive.
[in]	keyword_value	A value of the keyword to be set. If 0-length or NULL, will result in the keyword being removed. No error is given if that keyword does not exist.
[out]	buffer	Input buffer containing locale to be modified.
[in]	buffer_capacity	Capacity of receiving buffer

Returns:

The length needed for the buffer. If the keyword_name or buffer is NULL or the buffer_capacity is lower than 0, then the I18N_ERROR_INVALID_PARAMETER error will be set and -1 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

See also:

i18n_ulocale_get_keyword_value()

Returns a well-formed language tag for this locale ID.

Note : When strict is false, any locale fields which do not satisfy the BCP47 syntax requirement will be omitted from the result. When strict is true, this function sets I18N_ERROR_INVALID_PARAMETER to the result if any locale fields do not satisfy the BCP47 syntax requirement.

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exceptions section and i18n_error_code_e description.

Since :

2.3.1

Parameters:

[in]	locale_id	The input locale ID
[out]	langtag	The output buffer receiving BCP47 language tag for the locale ID.
[in]	langtag_capacity	The size of the BCP47 language tag output buffer.
[in]	strict	Boolean value indicating if the function returns an error for an ill-formed input locale ID.

Returns:

The length of the BCP47 language tag. If the locale_id or langtag buffer is NULL or the langtag_capacity is lower than 0, then the I18N_ERROR_INVALID_PARAMETER error will be set and -1 will be returned.

Exceptions:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter