php-doc-en/reference/mbstring/functions/mb-strcut.xml
Philip Olson a19afca437 WS, preparation for the new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@242741 c90b9560-bf6c-de11-be94-00142212c4b1
2007-09-20 20:55:38 +00:00

67 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.mb-strcut" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strcut</refname>
<refpurpose>Get part of string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strcut</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_strcut</function> returns the portion of
<parameter>str</parameter> specified by the
<parameter>start</parameter> and
<parameter>length</parameter> parameters.
</para>
<para>
<function>mb_strcut</function> performs equivalent operation as
<function>mb_substr</function> with different method. If
<parameter>start</parameter> position is multi-byte character's
second byte or larger, it starts from first byte of multi-byte
character.
</para>
<para>
It subtracts string from <parameter>str</parameter> that is
shorter than <parameter>length</parameter> AND character that is
not part of multi-byte string or not being middle of shift
sequence.
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
not set, internal character encoding is used.
</para>
<para>
See also <function>mb_substr</function>,
<function>mb_internal_encoding</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
-->