lib/libc/locale/freelocale.3

   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: head/lib/libc/locale/freelocale.3 250245 2013-05-04 17:21:44Z pluknet $
  29 .Dd September 17, 2011
  30 .Dt FREELOCALE 3
  31 .Os
  32 .Sh NAME
  33 .Nm freelocale
  34 .Nd Frees a locale created with
  35 .Xr duplocale 3
  36 or
  37 .Xr newlocale 3
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In xlocale.h
  42 .Ft int
  43 .Fn freelocale "locale_t locale"
  44 .Sh DESCRIPTION
  45 Frees a
  46 .Fa locale_t .
  47 This relinquishes any resources held exclusively by this locale.
  48 Note that locales share reference-counted components,
  49 so a call to this function is not guaranteed to free all of the components.
  50 .Sh RETURN VALUES
  51 Returns 0 on success or -1 on error.
  52 .Sh SEE ALSO
  53 .Xr duplocale 3 ,
  54 .Xr localeconv 3 ,
  55 .Xr newlocale 3 ,
  56 .Xr querylocale 3 ,
  57 .Xr uselocale 3 ,
  58 .Xr xlocale 3
  59 .Sh STANDARDS
  60 The
  61 .Fn freelocale
  62 function
  63 differs from
  64 .St -p1003.1-2008
  65 in that its return type is
  66 .Vt int
  67 rather than
  68 .Vt void .