1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry id="function.mb-substitute-character">
<refnamediv>
<refname>mb_substitute_character</refname>
<refpurpose>Set/Get substitution character</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>mb_substitute_character</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>substrchar</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_substitute_character</function> specifies
substitution character when input character encoding is invalid
or character code is not exist in output character
encoding. Invalid characters may be substituted &null;(no output),
string or integer value (Unicode character code value).
</para>
<para>
This setting affects <function>mb_convert_encoding</function>,
<function>mb_convert_variables</function>,
<function>mb_output_handler</function>,
and <function>mb_send_mail</function>.
</para>
<para>
<parameter>substchar</parameter> : Specify Unicode value as
integer or specify as string as follows
<itemizedlist>
<listitem>
<simpara>
"none" : no output
</simpara>
</listitem>
<listitem>
<simpara>
"long" : Output character code value (Example:
U+3000,JIS+7E7E)
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
Return Value: If <parameter>substchar</parameter> is set, it
returns &true; for success, otherwise returns
&false;. If <parameter>substchar</parameter> is
not set, it returns Unicode value or
"<literal>none</literal>"/"<literal>long</literal>".
</para>
<para>
<example>
<title><function>mb_substitute_character</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Set with Unicode U+3013 (GETA MARK) */
mb_substitute_character(0x3013);
/* Set hex format */
mb_substitute_character("long");
/* Display current setting */
echo mb_substitute_character();
?>
]]>
</programlisting>
</example>
</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
-->
|
