php-doc-en/reference/mbstring/functions/mb-get-info.xml

117 lines
3.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-get-info" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_get_info</refname>
<refpurpose>Get internal settings of mbstring</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>string</type><type>int</type><type>false</type></type><methodname>mb_get_info</methodname>
<methodparam choice="opt"><type>string</type><parameter>type</parameter><initializer>"all"</initializer></methodparam>
</methodsynopsis>
<simpara>
<function>mb_get_info</function> returns the internal setting parameters of mbstring.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
If <parameter>type</parameter> is not specified or is specified as <literal>"all"</literal>,
<literal>"internal_encoding"</literal>, <literal>"http_input"</literal>,
<literal>"http_output"</literal>, <literal>"http_output_conv_mimetypes"</literal>,
<literal>"mail_charset"</literal>, <literal>"mail_header_encoding"</literal>,
<literal>"mail_body_encoding"</literal>, <literal>"illegal_chars"</literal>,
<literal>"encoding_translation"</literal>, <literal>"language"</literal>,
<literal>"detect_order"</literal>, <literal>"substitute_character"</literal>
and <literal>"strict_detection"</literal>
will be returned.
</para>
<para>
If <parameter>type</parameter> is specified as
<literal>"internal_encoding"</literal>, <literal>"http_input"</literal>,
<literal>"http_output"</literal>, <literal>"http_output_conv_mimetypes"</literal>,
<literal>"mail_charset"</literal>, <literal>"mail_header_encoding"</literal>,
<literal>"mail_body_encoding"</literal>, <literal>"illegal_chars"</literal>,
<literal>"encoding_translation"</literal>, <literal>"language"</literal>,
<literal>"detect_order"</literal>, <literal>"substitute_character"</literal>
or <literal>"strict_detection"</literal>
the specified setting parameter will be returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>array</type> of type information if <parameter>type</parameter>
is not specified, otherwise a specific <parameter>type</parameter>,
&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
The <parameter>type</parameter>s <literal>"func_overload"</literal>
and <literal>"func_overload_list"</literal> are no longer supported.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mb_regex_encoding</function></member>
<member><function>mb_http_output</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
-->