xref: /freebsd/lib/libc/locale/querylocale.3 (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
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.\" $FreeBSD$
28.\"
29.Dd November 8, 2020
30.Dt QUERYLOCALE 3
31.Os
32.Sh NAME
33.Nm querylocale
34.Nd Look up the locale name or version for a specified category
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In locale.h
39.Ft const char *
40.Fn querylocale "int mask" "locale_t locale"
41.Sh DESCRIPTION
42Returns the name or version of the locale for the category specified by
43.Fa mask .
44The possible values for the mask are the same as those in
45.Xr newlocale 3 ,
46when requesting the locale name.
47Specify the bitwise OR of
48.Fa LC_VERSION_MASK
49and another mask value to request a version string.
50Version strings can be compared to detect changes to the locale's definition.
51The structure of the version string is unspecified.
52Currently, version information is only available for
53.Fa LC_COLLATE_MASK ,
54and an empty string is returned for other categories.
55If more than one bit in the mask is set, not counting
56.Fa LC_VERSION_MASK ,
57the returned value is undefined.
58.Sh SEE ALSO
59.Xr duplocale 3 ,
60.Xr freelocale 3 ,
61.Xr localeconv 3 ,
62.Xr newlocale 3 ,
63.Xr uselocale 3 ,
64.Xr xlocale 3
65.Sh HISTORY
66The
67.Fn querylocale
68function first appeared in
69.Fx 9.1 ,
70and is based on the function of the same name in Darwin.
71.Fa LC_VERSION_MASK
72first appeared in
73.Fx 13.0 .
74