uselocale(3) — Linux manual pages

Linux manual pages	Section 3

Name

uselocale — set/get the locale for the calling thread

Synopsis

        #include <locale.h>

locale_t uselocale( locale_t newloc);

Note

Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
`uselocale`():
Since glibc 2.10:
`_XOPEN_SOURCE` >= 700
Before glibc 2.10:
`_GNU_SOURCE`

DESCRIPTION

The uselocale() function sets the current locale for the calling thread, and returns the thread's previously current locale. After a successful call to uselocale(), any calls by this thread to functions that depend on the locale will operate as though the locale has been set to newloc.

The newloc argument can have one of the following values:

A handle returned by a call to newlocale(3) or duplocale(3): The calling thread's current locale is set to the specified locale.
The special locale object handle LC_GLOBAL_LOCALE: The calling thread's current locale is set to the global locale determined by setlocale(3).
(locale_t) 0: The calling thread's current locale is left unchanged (and the current locale is returned as the function result).

RETURN VALUE

On success, uselocale() returns the locale handle that was set by the previous call to uselocale() in this thread, or LC_GLOBAL_HANDLE if there was no such previous call. On error, it returns (locale_t) 0, and sets errno to indicate the cause of the error.

ERRORS

EINVAL: newloc does not refer to a valid locale object.

VERSIONS

The uselocale() function first appeared in version 2.3 of the GNU C library.

CONFORMING TO

POSIX.1-2008.

NOTES

Unlike setlocale(3), uselocale() does not allow selective replacement of individual locale categories. To employ a locale that differs in only a few categories from the current locale, use calls to duplocale(3) and newlocale(3) to obtain a locale object equivalent to the current locale and modify the desired categories in that object.

EXAMPLE

See newlocale(3) and duplocale(3).

COLOPHON

This page is part of release 4.07 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man−pages/.

  t
Copyright (C) 2014 Michael Kerrisk <mtk.manpagesgmail.com>

%%%LICENSE_START(VERBATIM)
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

Since the Linux kernel and libraries are constantly changing, this
manual page may be incorrect or out-of-date.  The author(s) assume no
responsibility for errors or omissions, or for damages resulting from
the use of the information contained herein.  The author(s) may not
have taken the same level of care in the production of this manual,
which is licensed free of charge, as they might when working
professionally.

Formatted or processed versions of this manual, if unaccompanied by
the source, must acknowledge the copyright and authors of this work.
%%%LICENSE_END