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
94
95
96
97
|
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-substr">
<refnamediv>
<refname>iconv_substr</refname>
<refpurpose>
Cut out part of a string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>iconv_substr</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns the portion of <parameter>str</parameter> specified by
the <parameter>start</parameter> and <parameter>length</parameter>
parameters.
</para>
<para>
If <parameter>start</parameter> is non-negative,
<function>iconv_substr</function> cuts the portion out of
<parameter>str</parameter> beginning at <parameter>start</parameter>'th
character, counting from zero.
</para>
<para>
If <parameter>start</parameter> is negative,
<function>iconv_substr</function> cuts out the portion beginning
at the position, <parameter>start</parameter> characters
away from the end of <parameter>str</parameter>.
</para>
<para>
If <parameter>length</parameter> is given and is positive, the return
value will contain at most <parameter>length</parameter> characters
of the portion that begins at <parameter>start</parameter>
(depending on the length of <parameter>string</parameter>).
If <parameter>str</parameter> is shorter than <parameter>start</parameter>
characters long, &false; will be returned.
</para>
<para>
If negative <parameter>length</parameter> is passed,
<function>iconv_substr</function> cuts the portion out of
<parameter>str</parameter> from the <parameter>start</parameter>'th
character up to the character that is
<parameter>length</parameter> characters away from the end of the string.
In case <parameter>start</parameter> is also negative, the start position
is calculated beforehand according to the rule explained above.
</para>
<para>
Note that <parameter>offset</parameter> and <parameter>length</parameter>
parameters are always deemed to represent offsets that are
calculated on the basis of the character set determined by
<parameter>charset</parameter>, whilst the counterpart
<function>substr</function> always takes these for byte offsets.
If <parameter>charset</parameter> is not given, the character set
is determined by the <link linkend="iconv.configuration">iconv.internal_encoding</link>
ini setting.
</para>
<para>
See also <function>substr</function>, <function>mb_substr</function>
and <function>mb_strcut</function>.
</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
-->
|
