Fix doc bug #61596 (Documentation doesn't mention negative return values).

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324696 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Adam Harvey 2012-04-02 06:52:56 +00:00
parent 6fd194c95e
commit 5e6e91b7dc

View file

@ -83,11 +83,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If only
two parameters were passed to this function, the values parsed
will be returned as an array. Otherwise, if optional parameters are passed,
the function will return the number of assigned values. The optional
parameters must be passed by reference.
If only two parameters were passed to this function, the values parsed will
be returned as an array. Otherwise, if optional parameters are passed, the
function will return the number of assigned values. The optional parameters
must be passed by reference.
</para>
<para>
If there are more substrings expected in the <parameter>format</parameter>
than there are available within <parameter>str</parameter>,
<literal>-1</literal> will be returned.
</para>
</refsect1>