locale/FreeBSD/nl_langinfo.3

   1 .\" Copyright (c) 2001 Alexey Zelkin <phantom@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/lib/libc/locale/nl_langinfo.3,v 1.7 2009/11/16 14:33:31 brueffer Exp $
  26 .\"
  27 .Dd May 3, 2001
  28 .Dt NL_LANGINFO 3
  29 .Os
  30 .Sh NAME
  31 .Nm nl_langinfo ,
  32 .Nm nl_langinfo_l
  33 .Nd language information
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In langinfo.h
  38 .Ft char *
  39 .Fo nl_langinfo
  40 .Fa "nl_item item"
  41 .Fc
  42 .In langinfo.h
  43 .In xlocale.h
  44 .Ft char *
  45 .Fo nl_langinfo_l
  46 .Fa "nl_item item"
  47 .Fa "locale_t loc"
  48 .Fc
  49 .Sh DESCRIPTION
  50 The
  51 .Fn nl_langinfo
  52 function returns a pointer to a string containing information relevant to
  53 the particular language or cultural area defined in the program's locale.
  54 The manifest constant names and values of
  55 .Fa item
  56 are defined in
  57 .In langinfo.h .
  58 .Pp
  59 Calls to
  60 .Fn setlocale
  61 with a category corresponding to the category of
  62 .Fa item ,
  63 or to the
  64 category
  65 .Dv LC_ALL ,
  66 may overwrite the buffer pointed to by the return value.
  67 .Sh RETURN VALUES
  68 In a locale where langinfo data is not defined,
  69 .Fn nl_langinfo
  70 returns a pointer to the corresponding string in the
  71 .Tn POSIX
  72 locale.
  73 In all locales,
  74 .Fn nl_langinfo
  75 returns a pointer to an empty string if
  76 .Fa item
  77 contains an invalid setting.
  78 .Sh EXAMPLES
  79 For example:
  80 .Pp
  81 .Dl nl_langinfo(ABDAY_1)
  82 .Pp
  83 would return a pointer to the string
  84 .Qq Li Dom
  85 if the identified language was
  86 Portuguese, and
  87 .Qq Li Sun
  88 if the identified language was English.
  89 .Pp
  90 While the
  91 .Fn nl_langinfo
  92 function uses the current locale, the
  93 .Fn nl_langinfo_l
  94 function may be passed a locale directly. See
  95 .Xr xlocale 3
  96 for more information.
  97 .Sh SEE ALSO
  98 .Xr setlocale 3 ,
  99 .Xr xlocale 3
 100 .Sh STANDARDS
 101 The
 102 .Fn nl_langinfo
 103 function conforms to
 104 .St -susv2 .
 105 .Sh HISTORY
 106 The
 107 .Fn nl_langinfo
 108 function first appeared in
 109 .Fx 4.6 .