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: head/lib/libc/locale/nl_langinfo.3 238919 2012-07-30 20:56:19Z issyl0 $ 26.\" 27.Dd July 30, 2012 28.Dt NL_LANGINFO 3 29.Os 30.Sh NAME 31.Nm nl_langinfo 32.Nd language information 33.Sh LIBRARY 34.Lb libc 35.Sh SYNOPSIS 36.In langinfo.h 37.Ft char * 38.Fn nl_langinfo "nl_item item" 39.Ft char * 40.Fn nl_langinfo_l "nl_item item" "locale_t loc" 41.Sh DESCRIPTION 42The 43.Fn nl_langinfo 44function returns a pointer to a string containing information relevant to 45the particular language or cultural area defined in the program or thread's 46locale, or in the case of 47.Fn nl_langinfo_l , 48the locale passed as the second argument. 49The manifest constant names and values of 50.Fa item 51are defined in 52.In langinfo.h . 53.Pp 54Calls to 55.Fn setlocale 56with a category corresponding to the category of 57.Fa item , 58or to the 59category 60.Dv LC_ALL , 61may overwrite the buffer pointed to by the return value. 62.Sh RETURN VALUES 63In a locale where langinfo data is not defined, 64.Fn nl_langinfo 65returns a pointer to the corresponding string in the 66.Tn POSIX 67locale. 68.Fn nl_langinfo_l 69returns the same values as 70.Fn nl_langinfo . 71In all locales, 72.Fn nl_langinfo 73returns a pointer to an empty string if 74.Fa item 75contains an invalid setting. 76.Sh EXAMPLES 77For example: 78.Pp 79.Dl nl_langinfo(ABDAY_1) 80.Pp 81would return a pointer to the string 82.Qq Li Dom 83if the identified language was 84Portuguese, and 85.Qq Li Sun 86if the identified language was English. 87.Sh SEE ALSO 88.Xr setlocale 3 89.Sh STANDARDS 90The 91.Fn nl_langinfo 92function conforms to 93.St -susv2 . 94The 95.Fn nl_langinfo_l 96function conforms to 97.St -p1003.1-2008 . 98.Sh HISTORY 99The 100.Fn nl_langinfo 101function first appeared in 102.Fx 4.6 . 103