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