lib/libcr/locale/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.3.2.1 2002/03/12 17:17:48 phantom Exp $
  26 .\" $DragonFly: src/lib/libcr/locale/Attic/nl_langinfo.3,v 1.2 2003/06/17 04:26:44 dillon Exp $
  27 .\"
  28 .Dd May 3, 2001
  29 .Dt NL_LANGINFO 3
  30 .Os
  31 .Sh NAME
  32 .Nm nl_langinfo
  33 .Nd language information
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In langinfo.h
  38 .Ft char *
  39 .Fn nl_langinfo "nl_item item"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn nl_langinfo
  43 function returns a pointer to a string containing information relevant to
  44 the particular language or cultural area defined in the program's locale.
  45 The manifest constant names and values of
  46 .Fa item
  47 are defined in
  48 .Aq Pa langinfo.h .
  49 .Pp
  50 Calls to
  51 .Fn setlocale
  52 with a category corresponding to the category of
  53 .Fa item ,
  54 or to the
  55 category
  56 .Dv LC_ALL ,
  57 may overwrite buffer pointed by the return value.
  58 .Sh EXAMPLES
  59 For example:
  60 .Pp
  61 .Dl nl_langinfo(ABDAY_1)
  62 .Pp
  63 would return a pointer to the string
  64 .Qq Li Dom
  65 if the identified language was
  66 Portuguese, and
  67 .Qq Li Sun
  68 if the identified language was English.
  69 .Sh RETURN VALUES
  70 In a locale where langinfo data is not defined,
  71 .Fn nl_langinfo
  72 returns a pointer to the corresponding string in the
  73 .Tn POSIX
  74 locale.
  75 In all locales,
  76 .Fn nl_langinfo
  77 returns a pointer to an empty string if
  78 .Fa item
  79 contains an invalid setting.
  80 .Sh SEE ALSO
  81 .Xr setlocale 3
  82 .Sh STANDARDS
  83 The
  84 .Fn nl_langinfo
  85 function conforms to
  86 .St -susv2 .
  87 .Sh HISTORY
  88 The
  89 .Fn nl_langinfo
  90 function first appeared in
  91 .Fx 4.6 .