moriyoshi Sun Nov 2 13:51:44 2003 EDT
Modified files:
/phpdoc/en/reference/iconv/functions iconv-strlen.xml
Log:
Initial documentation
Index: phpdoc/en/reference/iconv/functions/iconv-strlen.xml
diff -u phpdoc/en/reference/iconv/functions/iconv-strlen.xml:1.1
phpdoc/en/reference/iconv/functions/iconv-strlen.xml:1.2
--- phpdoc/en/reference/iconv/functions/iconv-strlen.xml:1.1 Sun Nov 2 11:53:20
2003
+++ phpdoc/en/reference/iconv/functions/iconv-strlen.xml Sun Nov 2 13:51:44
2003
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-strlen">
<refnamediv>
<refname>iconv_strlen</refname>
<refpurpose>
- Returns the character count of str
+ Returns the character count of string
</refpurpose>
</refnamediv>
<refsect1>
@@ -15,9 +15,20 @@
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
-
- &warn.undocumented.func;
-
+ <para>
+ Returns the character count of <parameter>string</parameter>.
+ </para>
+ <para>
+ In contrast to <function>strlen</function>, the return value of
+ <function>iconv_strlen</function> is the number of characters that occur
+ in the given byte sequence <parameter>string</parameter>, which is not
+ necessarily the same as the byte length of the string.
+ </para>
+ <para>
+ If <parameter>charset</parameter> parameter is omitted,
+ <parameter>string</parameter> will be assumed to be encoded in
+ <link linkend="iconv.configuration">iconv.internal_charset</link>.
+ </para>
</refsect1>
</refentry>
