1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="internals2.ze1.zendapi.macros.z-bval" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Z_BVAL</refname>
<refpurpose>Return a <type>zval</type> <varname>lval</varname> element as <type>bool</type></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<literallayout>#include <zend_operators.h></literallayout>
<methodsynopsis>
<type>zend_bool</type><methodname>Z_BVAL</methodname>
<methodparam><type>zval</type><parameter>zv</parameter></methodparam>
</methodsynopsis>
<para>
<function>Z_BVAL</function> returns the <varname>lval</varname> element
of <parameter>zv</parameter> casted to <type>zend_bool</type>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>zv</parameter></term>
<listitem>
<para>
The <type>zval</type> structure to extract the result value from.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The <varname>lval</varname> element of <parameter>zv</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_P</function> and <function>Z_BVAL_PP</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</function>, <function>Z_BINLEN</function>,
<function>Z_BINVAL</function>, <!-- <function>Z_BVAL</function> -->,
<function>Z_DVAL</function>, <function>Z_LVAL</function>,
<function>Z_OBJCE</function>, <function>Z_OBJ_HANDLE</function>,
<function>Z_OBJ_HANDLER</function>, <function>Z_OBJ_HT</function>,
<function>Z_OBJPROP</function>, <function>Z_OBJVAL</function>,
<function>Z_RESVAL</function>, <function>Z_STRLEN</function>,
<function>Z_STRVAL</function>, <function>Z_TYPE</function>,
<function>Z_UNILEN</function>, <function>Z_UNIVAL</function>,
<function>Z_USTRCPLEN</function>, <function>Z_USTRLEN</function>,
and <function>Z_USTRVAL</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:"~/.phpdoc/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
-->
|