xref: /freebsd/lib/libc/locale/uselocale.3 (revision e5b786625f7f82a1fa91e41823332459ea5550f9)
1.\" Copyright (c) 2011 The FreeBSD Foundation
2.\"
3.\" This documentation was written by David Chisnall under sponsorship from
4.\" the FreeBSD Foundation.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd September 17, 2011
28.Dt USELOCALE 3
29.Os
30.Sh NAME
31.Nm uselocale
32.Nd Sets a thread-local locale
33.Sh LIBRARY
34.Lb libc
35.Sh SYNOPSIS
36.In locale.h
37.Ft locale_t
38.Fn uselocale "locale_t locale"
39.Sh DESCRIPTION
40Specifies the locale for this thread to use.
41Specifying
42.Fa LC_GLOBAL_LOCALE
43disables the per-thread locale,
44while NULL returns the current locale without setting a new one.
45.Sh RETURN VALUES
46Returns the previous locale,
47or LC_GLOBAL_LOCALE if this thread has no locale associated with it.
48.Sh SEE ALSO
49.Xr duplocale 3 ,
50.Xr freelocale 3 ,
51.Xr localeconv 3 ,
52.Xr newlocale 3 ,
53.Xr querylocale 3 ,
54.Xr xlocale 3
55.Sh STANDARDS
56This function conforms to
57.St -p1003.1-2008 .
58