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