php-doc-en/internals/zendapi/api-macros.xml

<?xml version="1.0" encoding="ISO-8859-1" ?>
 <!-- $Revision: 1.1 $ -->
 <sect1 id="zend.api-macros">
  <title>API Macros</title>
  <para>A set of macros was introduced into Zend's API that simplify access to <envar>zval</envar>
   containers (see <xref linkend='tab.api-macros'/>).</para>
  
  <table id="tab.api-macros">
   <title>API Macros for Accessing <envar>zval</envar> Containers</title>
    <tgroup cols="2">
     <colspec colnum="1" colname="col1" colwidth="*"/>
     <colspec colnum="2" colname="col2" colwidth="*"/>
     <tbody>
      <row>
       <entry colname="col1">Macro</entry>
       <entry colname="col2">Refers to</entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_LVAL(zval)</literal></entry>
       <entry colname="col2"><envar>(zval).value.lval</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_DVAL(zval)</literal></entry>
       <entry colname="col2"><envar>(zval).value.dval</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_STRVAL(zval)</literal></entry>
       <entry colname="col2"><envar>(zval).value.str.val</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_STRLEN(zval)</literal></entry>
       <entry colname="col2"><envar>(zval).value.str.len</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_ARRVAL(zval)</literal></entry>
       <entry colname="col2"><envar>(zval).value.ht</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_LVAL_P(zval)</literal></entry>
       <entry colname="col2"><envar>(*zval).value.lval</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_DVAL_P(zval)</literal></entry>
       <entry colname="col2"><envar>(*zval).value.dval</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_STRVAL_P(zval_p)</literal></entry>
       <entry colname="col2"><envar>(*zval).value.str.val</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_STRLEN_P(zval_p)</literal></entry>
       <entry colname="col2"><envar>(*zval).value.str.len</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_ARRVAL_P(zval_p)</literal></entry>
       <entry colname="col2"><envar>(*zval).value.ht</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_LVAL_PP(zval_pp)</literal></entry>
       <entry colname="col2"><envar>(**zval).value.lval</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_DVAL_PP(zval_pp)</literal></entry>
       <entry colname="col2"><envar>(**zval).value.dval</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_STRVAL_PP(zval_pp)</literal></entry>
       <entry colname="col2"><envar>(**zval).value.str.val</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_STRLEN_PP(zval_pp)</literal></entry>
       <entry colname="col2"><envar>(**zval).value.str.len</envar></entry>
      </row>
      <row>
       <entry colname="col1"><literal>Z_ARRVAL_PP(zval_pp)</literal></entry>
       <entry colname="col2"><envar>(**zval).value.ht</envar></entry>
      </row>
     </tbody>
    </tgroup>
  </table>
 </sect1> 
<!-- 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
-->