xref: /freebsd/lib/libc/locale/freelocale.3 (revision 81ad6265)
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.Dd July 26, 2016
29.Dt FREELOCALE 3
30.Os
31.Sh NAME
32.Nm freelocale
33.Nd Frees a locale created with
34.Xr duplocale 3
35or
36.Xr newlocale 3
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In locale.h
41.Ft void
42.Fn freelocale "locale_t locale"
43.Sh DESCRIPTION
44Frees a
45.Fa locale_t .
46This relinquishes any resources held exclusively by this locale.
47Note that locales share reference-counted components,
48so a call to this function is not guaranteed to free all of the components.
49.Sh SEE ALSO
50.Xr duplocale 3 ,
51.Xr localeconv 3 ,
52.Xr newlocale 3 ,
53.Xr querylocale 3 ,
54.Xr uselocale 3 ,
55.Xr xlocale 3
56.Sh STANDARDS
57This function conforms to
58.St -p1003.1-2008 .
59