mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
created a seperate directory for Zend API macros
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@205222 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe
parent
ad3f2ef819
commit
a57ec08be2
41 changed files with 54 additions and 0 deletions
|
|
@ -0,0 +1,54 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<refentry id="zend-api-macro.ZEND-WRONG-PARAM-COUNT-WITH-RETVAL">
|
||||
<refnamediv>
|
||||
<refname>ZEND_WRONG_PARAM_COUNT_WITH_RETVAL</refname>
|
||||
<refpurpose>Generate standard error message and return custom value</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<literallayout>#include <zend_API.h></literallayout>
|
||||
<methodsynopsis>
|
||||
<type>void</type><methodname>ZEND_WRONG_PARAM_COUNT_WITH_RETVAL</methodname>
|
||||
<methodparam><type>mixed</type><parameter>return_value</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<note><simpara>This macro is part of the API but not used in any bundled or PECL extension</simpara></note>
|
||||
<para>
|
||||
<function>ZEND_WRONG_PARAM_COUNT_WITH_RETVAL</function> produces a standard warning message
|
||||
for functions or class methods that have been called with a wrong number of
|
||||
parameters and returns its parameter to the calling function.
|
||||
The macro automaticly puts the right function name and class
|
||||
name (if needed) into the error message.
|
||||
</para>
|
||||
<para>
|
||||
The <parameter>return_value</parameter> parameter is returned to the calling
|
||||
function of the current one.
|
||||
</para>
|
||||
<para>
|
||||
<function>ZEND_WRONG_PARAM_COUNT_WITH_RETVAL</function> is actually a convenience
|
||||
wrapper for <function>zend_wrong_param_count</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
|
||||
-->
|
||||
Loading…
Reference in a new issue