php-doc-en/internals/zendapi/macros/Z_BVAL_PP.xml
2006-01-22 14:57:08 +00:00

92 lines
3.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry id="zend-macro.z-bval-pp">
<refnamediv>
<refname>Z_BVAL_PP</refname>
<refpurpose>Dereference a pointer to a <type>zval</type> pointer and return its <varname>lval</varname> element as <type>bool</type></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<literallayout>#include &lt;zend_operators.h&gt;</literallayout>
<methodsynopsis>
<type>zend_bool</type><methodname>Z_BVAL_PP</methodname>
<methodparam><type>zval **</type><parameter>zval_pp</parameter></methodparam>
</methodsynopsis>
<para>
<function>Z_BVAL_P</function> returns the <varname>lval</varname> element
of the <type>zval</type> structure indirectly pointed to by
<parameter>zval_pp</parameter> casted to <type>zend_bool</type>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>zval_pp</parameter></term>
<listitem>
<para>
Pointer to a pointer to the <type>zval</type> structure to extract the resut value from.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The <varname>lval</varname> element of the <type>zval</type> structure
pointed to by the pointer pointed to by <parameter>zval_pp</parameter>
casted to a <type>zend_bool</type> which is either &true; or &false;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See <function>Z_BVAL</function> and <function>Z_BVAL_P</function> for other
macros that access the <varname>lval</varname> field of a <type>zval</type>
as <type>zend_bool</type>.
</para>
<para>
For macros that extract other values from a <type>zval **</type> see
<function>Z_ARRVAL_PP</function>, <function>Z_BINLEN_PP</function>,
<function>Z_BINVAL_PP</function>, <!-- <function>Z_BVAL_PP</function> -->,
<function>Z_DVAL_PP</function>, <function>Z_LVAL_PP</function>,
<function>Z_OBJCE_PP</function>, <function>Z_OBJ_HANDLE_PP</function>,
<function>Z_OBJ_HANDLER_PP</function>, <function>Z_OBJ_HT_PP</function>,
<function>Z_OBJPROP_PP</function>, <function>Z_OBJVAL_PP</function>,
<function>Z_RESVAL_PP</function>, <function>Z_STRLEN_PP</function>,
<function>Z_STRVAL_PP</function>, <function>Z_TYPE_PP</function>,
<function>Z_UNILEN_PP</function>, <function>Z_UNIVAL_PP</function>,
<function>Z_USTRCPLEN_PP</function>, <function>Z_USTRLEN_PP</function>,
and <function>Z_USTRVAL_PP</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
-->