xref: /illumos-gate/usr/src/man/man3c/nl_langinfo.3c (revision 45ede40b2394db7967e59f19288fae9b62efd4aa)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved
Copyright 2014 Garrett D'Amore <garrett@damore.org>

NL_LANGINFO 3C "Jun 24, 2014"
NAME
nl_langinfo, nl_langinfo_l - language information
SYNOPSIS

#include <langinfo.h>

char *nl_langinfo(nl_item item);

char *nl_langinfo_l(nl_item item, locale_t loc);
DESCRIPTION

The nl_langinfo() function returns a pointer to a null-terminated string containing information relevant to a particular language or cultural area defined in the programs locale. The manifest constant names and values of item are defined by <langinfo.h>. For example:

nl_langinfo(ABDAY_1);

would return a pointer to the string "Dim" if the identified language was French and a French locale was correctly installed; or "Sun" if the identified language was English.

The function nl_langinfo_l() behaves identically to nl_langinfo(), except instead of acting in the current locale, it instead acts in the locale specified by loc.

RETURN VALUES

If the locale has not been set or is invalid, or if data for a supported language is either not available, or if item is not defined therein, then these functions return a pointer to the corresponding string in the C locale. In all locales, they return a pointer to an empty string if item contains an invalid setting.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
CSI Enabled
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

newlocale(3C), setlocale(3C), uselocale(3C), langinfo.h(3HEAD), nl_types.h(3HEAD), attributes(5), standards(5)

WARNINGS

The array pointed to by the return value should not be modified by the program. Subsequent calls to these functions may overwrite the array.