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