Initial documentation

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@143617 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Moriyoshi Koizumi 2003-11-02 19:08:41 +00:00
parent ceb2059213
commit 196836d7ac

View file

@ -1,25 +1,47 @@
<?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-strpos">
<refnamediv>
<refname>iconv_strpos</refname>
<refpurpose>
Finds position of first occurrence of needle within part of haystack beginning with offset
Finds position of first occurrence of a needle within a haystack.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>iconv_strpos</methodname>
<type>int</type><methodname>iconv_strpos</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns the numeric position of the first occurrence of
<parameter>needle</parameter> in <parameter>haystack</parameter>.
</para>
<para>
The optional <parameter>offset</parameter> parameter specifies
the position from which the search should be performed.
</para>
<para>
If <parameter>needle</parameter> is not found,
<function>strpos</function> will return &false;.
</para>
&warn.undocumented.func;
&return.falseproblem;
<para>
If <parameter>haystack</parameter> or <parameter>needle</parameter> is
not a string, it is converted to an integer and applied as the ordinal
value of a character.
</para>
<para>
See also <function>strpos</function> and
<function>iconv_strrpos</function>.
</para>
</refsect1>
</refentry>