[PHP-DOC] cvs: phpdoc /en/internals/zendapi/functions ZEND_WRONG_PARAM_COUNT_WITH_RETVAL.xml

[Hartmut Holzgraefe]

hholzgra                Mon Aug 29 15:45:41 2005 EDT

  Added files:                 
    /phpdoc/en/internals/zendapi/functions      
                                                
ZEND_WRONG_PARAM_COUNT_WITH_RETVAL.xml 
  Log:
  another macro documented
  
  

http://cvs.php.net/co.php/phpdoc/en/internals/zendapi/functions/ZEND_WRONG_PARAM_COUNT_WITH_RETVAL.xml?r=1.1&p=1
Index: 
phpdoc/en/internals/zendapi/functions/ZEND_WRONG_PARAM_COUNT_WITH_RETVAL.xml
+++ phpdoc/en/internals/zendapi/functions/ZEND_WRONG_PARAM_COUNT_WITH_RETVAL.xml
<?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 &lt;zend_API.h&gt;</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
-->