.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2011
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file is part of the m17n library documentation.
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Section, no Front-Cover Texts,
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "m17nLocale" 3m17n "Mon Sep 25 2023" "Version 1.8.4" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
m17nLocale_\-_Lo \-  \- Locale objects and API for them\&.  

.SH SYNOPSIS
.br
.PP
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef struct \fBMLocale\fP \fBMLocale\fP"
.br
.RI "\fCstruct\fP \fCMLocale\fP\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBMPlist\fP * \fBmlanguage_list\fP (void)"
.br
.RI "List 3-letter language codes\&. "
.ti -1c
.RI "MSymbol \fBmlanguage_code\fP (MSymbol language, int len)"
.br
.RI "Get a language code\&. "
.ti -1c
.RI "\fBMPlist\fP * \fBmlanguage_name_list\fP (MSymbol language, MSymbol target, MSymbol script, MSymbol territory)"
.br
.RI "Return the language names written in the specified language\&. "
.ti -1c
.RI "\fBMText\fP * \fBmlanguage_text\fP (MSymbol language)"
.br
.RI "Return the language name written in that language\&. "
.ti -1c
.RI "\fBMPlist\fP * \fBmscript_list\fP (void)"
.br
.RI "List script names\&. "
.ti -1c
.RI "\fBMPlist\fP * \fBmscript_language_list\fP (MSymbol script)"
.br
.RI "List languages that use a specified script\&. "
.ti -1c
.RI "\fBMLocale\fP * \fBmlocale_set\fP (int category, const char *name)"
.br
.RI "Set the current locale\&. "
.ti -1c
.RI "MSymbol \fBmlocale_get_prop\fP (\fBMLocale\fP *locale, MSymbol key)"
.br
.RI "Get the value of a locale property\&. "
.ti -1c
.RI "int \fBmtext_ftime\fP (\fBMText\fP *mt, const char *format, const struct tm *tm, \fBMLocale\fP *locale)"
.br
.RI "Format date and time\&. "
.ti -1c
.RI "\fBMText\fP * \fBmtext_getenv\fP (const char *name)"
.br
.RI "Get an environment variable\&. "
.ti -1c
.RI "int \fBmtext_putenv\fP (\fBMText\fP *mt)"
.br
.RI "Change or add an environment variable\&. "
.ti -1c
.RI "int \fBmtext_coll\fP (\fBMText\fP *mt1, \fBMText\fP *mt2)"
.br
.RI "Compare two M-texts using the current locale\&. "
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "MSymbol \fBMiso639_1\fP"
.br
.ti -1c
.RI "MSymbol \fBMiso639_2\fP"
.br
.ti -1c
.RI "MSymbol \fBMterritory\fP"
.br
.ti -1c
.RI "MSymbol \fBMmodifier\fP"
.br
.ti -1c
.RI "MSymbol \fBMcodeset\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Locale objects and API for them\&. 

The m17n library represents locale related information as objects of type \fBMLocale\fP\&. 
.br
 
.SH "Typedef Documentation"
.PP 
.SS "typedef struct \fBMLocale\fP \fBMLocale\fP"

.PP
\fCstruct\fP \fCMLocale\fP\&. The structure \fCMLocale\fP is used to hold information about name, language, territory, modifier, codeset, and the corresponding coding system of locales\&.
.PP
The contents of this structure are implementation dependent\&. Its internal structure is concealed from application programs\&. 
.br
.PP

\fBSEE ALSO\fp

.RS 4
\fBmlocale_get_prop()\fP 
.br
 
.RE
.PP

.SH "Variable Documentation"
.PP 
.SS "MSymbol Miso639_1"

.SS "MSymbol Miso639_2"

.SS "MSymbol Mterritory"
The symbol whose name is 'territory'\&. 
.SS "MSymbol Mmodifier"
The symbol whose name is 'modifier'\&. 
.SS "MSymbol Mcodeset"
The symbol whose name is 'codeset'\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for The m17n Library from the source code\&.
.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2011 National Institute of Advanced Industrial Science and Technology (AIST)
.br
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License 
<http://www.gnu.org/licenses/fdl.html>.