The Open Group Base Specifications Issue 7
IEEE Std 1003.1-2008, 2016 Edition
Copyright © 2001-2016 The IEEE and The Open Group

#### NAME

> uselocale - use locale in current thread

#### SYNOPSIS

> ``[CX] #include <locale.h>
> locale_t uselocale(locale_t` newloc`);``
> `
> `

#### DESCRIPTION

> The uselocale() function shall set or query the current locale for the calling thread.

> The value for the newloc argument shall be one of the following:

> 1. A value returned by the newlocale() or duplocale() functions

> 2. The special locale object descriptor LC_GLOBAL_LOCALE

> 3. (locale_t)0

> If the newloc argument is (locale_t)0, the current locale shall not be changed; this value can be used to query the current locale setting. If the newloc argument is LC_GLOBAL_LOCALE, any thread-local locale for the calling thread shall be uninstalled; the thread shall again use the global locale as the current locale, and changes to the global locale shall affect the thread. Otherwise, the locale represented by newloc shall be installed as a thread-local locale to be used as the current locale for the calling thread.

> Once the uselocale() function has been called to install a thread-local locale, the behavior of every interface using data from the current locale shall be affected for the calling thread. The current locale for other threads shall remain unchanged.

#### RETURN VALUE

> Upon successful completion, the uselocale() function shall return a handle for the thread-local locale that was in use as the current locale for the calling thread on entry to the function, or LC_GLOBAL_LOCALE if no thread-local locale was in use. Otherwise, uselocale() shall return (locale_t)0 and set errno to indicate the error.

#### ERRORS

> The uselocale() function may fail if:

> [EINVAL]
>   newloc is not a valid locale object and is not (locale_t)0.

The following sections are informative.

#### EXAMPLES

> None.

#### APPLICATION USAGE

> Unlike the setlocale() function, the uselocale() function does not allow replacing some locale categories only. Applications that need to install a locale which differs only in a few categories must use newlocale() to change a locale object equivalent to the currently used locale and install it.

#### RATIONALE

> None.

#### FUTURE DIRECTIONS

> None.

#### SEE ALSO

> duplocale, freelocale, newlocale, setlocale

> XBD <locale.h>

#### CHANGE HISTORY

> First released in Issue 7.

> POSIX.1-2008, Technical Corrigendum 1, XSH/TC1-2008/0700 [290] and XSH/TC1-2008/0701 [334] are applied.

> POSIX.1-2008, Technical Corrigendum 2, XSH/TC2-2008/0382 [582] is applied.

End of informative text.

return to top of page

UNIX ® is a registered Trademark of The Open Group.
POSIX ® is a registered Trademark of The IEEE.
Copyright © 2001-2016 The IEEE and The Open Group, All Rights Reserved
[ Main Index | XBD | XSH | XCU | XRAT ]