php-doc-en/reference/strings/functions/nl-langinfo.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

308 lines
11 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.nl-langinfo">
<refnamediv>
<refname>nl_langinfo</refname>
<refpurpose>Query language and locale information</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>nl_langinfo</methodname>
<methodparam><type>int</type><parameter>item</parameter></methodparam>
</methodsynopsis>
<para>
<function>nl_langinfo</function> is used to access individual elements of
the locale categories. Unlike <function>localeconv</function>, which
returns all of the elements, <function>nl_langinfo</function> allows you
to select any specific element.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>item</parameter></term>
<listitem>
<para>
<parameter>item</parameter> may be an integer value of the element or the
constant name of the element. The following is a list of constant names
for <parameter>item</parameter> that may be used and their description.
Some of these constants may not be defined or hold no value for certain
locales.
<table>
<title>nl_langinfo Constants</title>
<tgroup cols="2">
<colspec colname="c1" />
<colspec colname="c2" />
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry namest="c1" nameend="c2" align="center"><emphasis>LC_TIME Category Constants</emphasis></entry>
</row>
<row>
<entry><constant>ABDAY_(1-7)</constant></entry>
<entry>Abbreviated name of n-th day of the week.</entry>
</row>
<row>
<entry><constant>DAY_(1-7)</constant></entry>
<entry>Name of the n-th day of the week (DAY_1 = Sunday).</entry>
</row>
<row>
<entry><constant>ABMON_(1-12)</constant></entry>
<entry>Abbreviated name of the n-th month of the year.</entry>
</row>
<row>
<entry><constant>MON_(1-12)</constant></entry>
<entry>Name of the n-th month of the year.</entry>
</row>
<row>
<entry><constant>AM_STR</constant></entry>
<entry>String for Ante meridian.</entry>
</row>
<row>
<entry><constant>PM_STR</constant></entry>
<entry>String for Post meridian.</entry>
</row>
<row>
<entry><constant>D_T_FMT</constant></entry>
<entry>String that can be used as the format string for <function>strftime</function> to represent time and date.</entry>
</row>
<row>
<entry><constant>D_FMT</constant></entry>
<entry>String that can be used as the format string for <function>strftime</function> to represent date.</entry>
</row>
<row>
<entry><constant>T_FMT</constant></entry>
<entry>String that can be used as the format string for <function>strftime</function> to represent time.</entry>
</row>
<row>
<entry><constant>T_FMT_AMPM</constant></entry>
<entry>String that can be used as the format string for <function>strftime</function> to represent time in 12-hour format with ante/post meridian.</entry>
</row>
<row>
<entry><constant>ERA</constant></entry>
<entry>Alternate era.</entry>
</row>
<row>
<entry><constant>ERA_YEAR</constant></entry>
<entry>Year in alternate era format.</entry>
</row>
<row>
<entry><constant>ERA_D_T_FMT</constant></entry>
<entry>Date and time in alternate era format (string can be used in <function>strftime</function>).</entry>
</row>
<row>
<entry><constant>ERA_D_FMT</constant></entry>
<entry>Date in alternate era format (string can be used in <function>strftime</function>).</entry>
</row>
<row>
<entry><constant>ERA_T_FMT</constant></entry>
<entry>Time in alternate era format (string can be used in <function>strftime</function>).</entry>
</row>
<row>
<entry namest="c1" nameend="c2" align="center"><emphasis>LC_MONETARY Category Constants</emphasis></entry>
</row>
<row>
<entry><constant>INT_CURR_SYMBOL</constant></entry>
<entry>International currency symbol.</entry>
</row>
<row>
<entry><constant>CURRENCY_SYMBOL</constant></entry>
<entry>Local currency symbol.</entry>
</row>
<row>
<entry><constant>CRNCYSTR</constant></entry>
<entry>Same value as <constant>CURRENCY_SYMBOL</constant>.</entry>
</row>
<row>
<entry><constant>MON_DECIMAL_POINT</constant></entry>
<entry>Decimal point character.</entry>
</row>
<row>
<entry><constant>MON_THOUSANDS_SEP</constant></entry>
<entry>Thousands separator (groups of three digits).</entry>
</row>
<row>
<entry><constant>MON_GROUPING</constant></entry>
<entry>Like <literal>"grouping"</literal> element.</entry>
</row>
<row>
<entry><constant>POSITIVE_SIGN</constant></entry>
<entry>Sign for positive values.</entry>
</row>
<row>
<entry><constant>NEGATIVE_SIGN</constant></entry>
<entry>Sign for negative values.</entry>
</row>
<row>
<entry><constant>INT_FRAC_DIGITS</constant></entry>
<entry>International fractional digits.</entry>
</row>
<row>
<entry><constant>FRAC_DIGITS</constant></entry>
<entry>Local fractional digits.</entry>
</row>
<row>
<entry><constant>P_CS_PRECEDES</constant></entry>
<entry>Returns 1 if <constant>CURRENCY_SYMBOL</constant> precedes a positive value.</entry>
</row>
<row>
<entry><constant>P_SEP_BY_SPACE</constant></entry>
<entry>Returns 1 if a space separates <constant>CURRENCY_SYMBOL</constant> from a positive value.</entry>
</row>
<row>
<entry><constant>N_CS_PRECEDES</constant></entry>
<entry>Returns 1 if <constant>CURRENCY_SYMBOL</constant> precedes a negative value.</entry>
</row>
<row>
<entry><constant>N_SEP_BY_SPACE</constant></entry>
<entry>Returns 1 if a space separates <constant>CURRENCY_SYMBOL</constant> from a negative value.</entry>
</row>
<row>
<entry><constant>P_SIGN_POSN</constant></entry>
<entry morerows="1" valign="middle">
<itemizedlist>
<listitem>
<simpara>
Returns 0 if parentheses surround the quantity and <constant>CURRENCY_SYMBOL</constant>.
</simpara>
</listitem>
<listitem>
<simpara>
Returns 1 if the sign string precedes the quantity and <constant>CURRENCY_SYMBOL</constant>.
</simpara>
</listitem>
<listitem>
<simpara>
Returns 2 if the sign string follows the quantity and <constant>CURRENCY_SYMBOL</constant>.
</simpara>
</listitem>
<listitem>
<simpara>
Returns 3 if the sign string immediately precedes the <constant>CURRENCY_SYMBOL</constant>.
</simpara>
</listitem>
<listitem>
<simpara>
Returns 4 if the sign string immediately follows the <constant>CURRENCY_SYMBOL</constant>.
</simpara>
</listitem>
</itemizedlist>
</entry>
</row>
<row>
<entry><constant>N_SIGN_POSN</constant></entry>
</row>
<row>
<entry namest="c1" nameend="c2" align="center"><emphasis>LC_NUMERIC Category Constants</emphasis></entry>
</row>
<row>
<entry><constant>DECIMAL_POINT</constant></entry>
<entry>Decimal point character.</entry>
</row>
<row>
<entry><constant>RADIXCHAR</constant></entry>
<entry>Same value as <constant>DECIMAL_POINT</constant>.</entry>
</row>
<row>
<entry><constant>THOUSANDS_SEP</constant></entry>
<entry>Separator character for thousands (groups of three digits).</entry>
</row>
<row>
<entry><constant>THOUSEP</constant></entry>
<entry>Same value as <constant>THOUSANDS_SEP</constant>.</entry>
</row>
<row>
<entry><constant>GROUPING</constant></entry>
<entry></entry>
</row>
<row>
<entry namest="c1" nameend="c2" align="center"><emphasis>LC_MESSAGES Category Constants</emphasis></entry>
</row>
<row>
<entry><constant>YESEXPR</constant></entry>
<entry>Regex string for matching <literal>"yes"</literal> input.</entry>
</row>
<row>
<entry><constant>NOEXPR</constant></entry>
<entry>Regex string for matching <literal>"no"</literal> input.</entry>
</row>
<row>
<entry><constant>YESSTR</constant></entry>
<entry>Output string for <literal>"yes"</literal>.</entry>
</row>
<row>
<entry><constant>NOSTR</constant></entry>
<entry>Output string for <literal>"no"</literal>.</entry>
</row>
<row>
<entry namest="c1" nameend="c2" align="center"><emphasis>LC_CTYPE Category Constants</emphasis></entry>
</row>
<row>
<entry><constant>CODESET</constant></entry>
<entry>Return a string with the name of the character encoding.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the element as a string, or &false; if <parameter>item</parameter>
is not valid.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.no-windows;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>setlocale</function></member>
<member><function>localeconv</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->