58912ae7c3
Fix a missing .h and change the recommended include for the POSIX2008 functions from xlocale.h to locale.h. Including xlocale.h is for legacy / Darwin compatibility so should not be encouraged.
69 lines
2.2 KiB
Groff
69 lines
2.2 KiB
Groff
.\" Copyright (c) 2011 The FreeBSD Foundation
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This documentation was written by David Chisnall under sponsorship from
|
|
.\" the FreeBSD Foundation.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.Dd September 17, 2011
|
|
.Dt FREELOCALE 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm freelocale
|
|
.Nd Frees a locale created with
|
|
.Xr duplocale 3
|
|
or
|
|
.Xr newlocale 3
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In locale.h
|
|
.Ft int
|
|
.Fn freelocale "locale_t locale"
|
|
.Sh DESCRIPTION
|
|
Frees a
|
|
.Fa locale_t .
|
|
This relinquishes any resources held exclusively by this locale.
|
|
Note that locales share reference-counted components,
|
|
so a call to this function is not guaranteed to free all of the components.
|
|
.Sh RETURN VALUES
|
|
Returns 0 on success or -1 on error.
|
|
.Sh SEE ALSO
|
|
.Xr duplocale 3 ,
|
|
.Xr localeconv 3 ,
|
|
.Xr newlocale 3 ,
|
|
.Xr querylocale 3 ,
|
|
.Xr uselocale 3 ,
|
|
.Xr xlocale 3
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn freelocale
|
|
function
|
|
differs from
|
|
.St -p1003.1-2008
|
|
in that its return type is
|
|
.Vt int
|
|
rather than
|
|
.Vt void .
|