'\" et

.TH locale.h "0P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"

.SH PROLOG

This manual page is part of the POSIX Programmer's Manual.

The Linux implementation of this interface may differ (consult

the corresponding Linux manual page for details of Linux behavior),

or the interface may not be implemented on Linux.

.SH NAME

locale.h

\(em category macros

.SH SYNOPSIS

.LP

.nf

#include <locale.h>

.fi

.SH DESCRIPTION

Some of the functionality described on this reference page extends the

ISO\ C standard. Applications shall define the appropriate feature test macro

(see the System Interfaces volume of POSIX.1\(hy2008,

.IR "Section 2.2" ", " "The Compilation Environment")

to enable the visibility of these symbols in this header.

.P

The

.IR <locale.h> 

header shall define the

.BR lconv

structure, which shall include at least the following members.

(See the definitions of

.IR LC_MONETARY

in

.IR "Section 7.3.3" ", " "LC_MONETARY"

and

.IR "Section 7.3.4" ", " "LC_NUMERIC".)

.sp

.RS 4

.nf

\fB

char    *currency_symbol

char    *decimal_point

char     frac_digits

char    *grouping

char    *int_curr_symbol

char     int_frac_digits

char     int_n_cs_precedes

char     int_n_sep_by_space

char     int_n_sign_posn

char     int_p_cs_precedes

char     int_p_sep_by_space

char     int_p_sign_posn

char    *mon_decimal_point

char    *mon_grouping

char    *mon_thousands_sep

char    *negative_sign

char     n_cs_precedes

char     n_sep_by_space

char     n_sign_posn

char    *positive_sign

char     p_cs_precedes

char     p_sep_by_space

char     p_sign_posn

char    *thousands_sep

.fi \fR

.P

.RE

.P

The

.IR <locale.h> 

header shall define NULL (as described in

.IR <stddef.h> )

and at least the following as macros:

.P

.nf

LC_ALL

LC_COLLATE

LC_CTYPE

LC_MESSAGES

LC_MONETARY

LC_NUMERIC

LC_TIME

.fi

.P

which shall expand to integer constant expressions with distinct

values for use as the first argument to the

\fIsetlocale\fR()

function.

.P

Implementations may add additional masks using the form

.IR LC_*

and an uppercase letter.

.P

The

.IR <locale.h> 

header shall contain at least the following macros representing

bitmasks for use with the

\fInewlocale\fR()

function for each supported locale category:

LC_COLLATE_MASK

LC_CTYPE_MASK

LC_MESSAGES_MASK

LC_MONETARY_MASK

LC_NUMERIC_MASK

LC_TIME_MASK

.P

Implementations may add additional masks using the form LC_*_MASK.

.P

In addition, a macro to set the bits for all categories set shall be

defined:

LC_ALL_MASK

.P

The

.IR <locale.h> 

header shall define LC_GLOBAL_LOCALE, a special locale object descriptor

used by the

\fIduplocale\fR()

and

\fIuselocale\fR()

functions.

.P

The

.IR <locale.h> 

header shall define the

.BR locale_t

type, representing a locale object.

.P

The following shall be declared as functions and may also be defined as

macros. Function prototypes shall be provided for use with ISO\ C standard

compilers.

.sp

.RS 4

.nf

\fB

locale_t      duplocale(locale_t);

void          freelocale(locale_t);

struct lconv *localeconv(void);

locale_t      newlocale(int, const char *, locale_t);

char         *setlocale(int, const char *);

locale_t      uselocale (locale_t);

.fi \fR

.P

.RE

.LP

.IR "The following sections are informative."

.SH "APPLICATION USAGE"

None.

.SH RATIONALE

None.

.SH "FUTURE DIRECTIONS"

None.

.SH "SEE ALSO"

.IR "Chapter 8" ", " "Environment Variables",

.IR "\fB<stddef.h>\fP"

.P

The System Interfaces volume of POSIX.1\(hy2008,

.IR "\fIduplocale\fR\^(\|)",

.IR "\fIfreelocale\fR\^(\|)",

.IR "\fIlocaleconv\fR\^(\|)",

.IR "\fInewlocale\fR\^(\|)",

.IR "\fIsetlocale\fR\^(\|)",

.IR "\fIuselocale\fR\^(\|)"

.SH COPYRIGHT

Portions of this text are reprinted and reproduced in electronic form

from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology

-- Portable Operating System Interface (POSIX), The Open Group Base

Specifications Issue 7, Copyright (C) 2013 by the Institute of

Electrical and Electronics Engineers, Inc and The Open Group.

(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the

event of any discrepancy between this version 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.unix.org/online.html .

Any typographical or formatting errors that appear

in this page are most likely

to have been introduced during the conversion of the source files to

man page format. To report such errors, see

https://www.kernel.org/doc/man-pages/reporting_bugs.html .