cvs: phpdoc /en/reference/unicode/functions unicode-set-subst-char.xml

nicobn Mon Aug 20 05:20:10 2007 UTC Added files: /phpdoc/en/reference/unicode/functions unicode-set-subst-char.xml Log: Added the unicode_set_subst_char() function http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/unicode/functions/unicode-set-subst-char.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/unicode/functions/unicode-set-subst-char.xml +++ phpdoc/en/reference/unicode/functions/unicode-set-subst-char.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.unicode-set-subst-char"> <refnamediv> <refname>unicode_set_subst_char</refname> <refpurpose>Set the substitution character for string conversion errors</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>unicode_set_subst_char</methodname> <methodparam><type>unicode</type><parameter>character</parameter></methodparam> </methodsynopsis> <para> When converting a string from or to unicode, an invalid or unconvertable character may be encountered. When the conversion error mode is set to <constant>U_CONV_ERROR_SUBST</constant>, the character that caused the error is substituted by a character set by this function. The default substitution character is <literal>?</literal>. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>character</parameter></term> <listitem> <para> The substitution character to use. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; &return.success; </refsect1> <refsect1 role="errors"> &reftitle.errors; <para> Emits a <constant>E_WARNING</constant> level error if <parameter>character</parameter> is invalid. </para> </refsect1> <refsect1 role="notes"> &reftitle.notes; &warn.experimental.func; </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>unicode_set_error_mode</function></member> <member><function>unicode_get_error_mode</function></member> <member><function>unicode_encode</function></member> <member><function>unicode_decode</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:"../../../../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 -->