finished Z_BVAL*.xml as examples for all Z_*VAL*.xml macros

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@205705 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2006-01-22 14:57:08 +00:00
parent c3c7337699
commit 6fb353ddea
3 changed files with 94 additions and 14 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="zend-macro.z-bval">
<refnamediv>
<refname>Z_BVAL</refname>
@ -11,10 +11,11 @@
<literallayout>#include &lt;zend_operators.h&gt;</literallayout>
<methodsynopsis>
<type>zend_bool</type><methodname>Z_BVAL</methodname>
<methodparam><type>zval</type><parameter>zval</parameter></methodparam>
<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>
@ -23,10 +24,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>zval</parameter></term>
<term><parameter>zv</parameter></term>
<listitem>
<para>
...
The <type>zval</type> structure to extract the resut value from.
</para>
</listitem>
</varlistentry>
@ -37,10 +38,35 @@
<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_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</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

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="zend-macro.z-bval-p">
<refnamediv>
<refname>Z_BVAL_P</refname>
@ -14,7 +14,9 @@
<methodparam><type>zval *</type><parameter>zval_p</parameter></methodparam>
</methodsynopsis>
<para>
...
<function>Z_BVAL_P</function> returns the <varname>lval</varname> element
of the <type>zval</type> structure pointed to by <parameter>zval_p</parameter>
casted to <type>zend_bool</type>.
</para>
</refsect1>
@ -26,7 +28,7 @@
<term><parameter>zval_p</parameter></term>
<listitem>
<para>
...
Pointer to the <type>zval</type> structure to extract the resut value from.
</para>
</listitem>
</varlistentry>
@ -37,10 +39,35 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
...
The <varname>lval</varname> element of the <type>zval</type> structure
pointed to by <parameter>zval_p</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_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_P</function>, <function>Z_BINLEN_P</function>,
<function>Z_BINVAL_P</function>, <!-- <function>Z_BVAL_P</function> -->,
<function>Z_DVAL_P</function>, <function>Z_LVAL_P</function>,
<function>Z_OBJCE_P</function>, <function>Z_OBJ_HANDLE_P</function>,
<function>Z_OBJ_HANDLER_P</function>, <function>Z_OBJ_HT_P</function>,
<function>Z_OBJPROP_P</function>, <function>Z_OBJVAL_P</function>,
<function>Z_RESVAL_P</function>, <function>Z_STRLEN_P</function>,
<function>Z_STRVAL_P</function>, <function>Z_TYPE_P</function>,
<function>Z_UNILEN_P</function>, <function>Z_UNIVAL_P</function>,
<function>Z_USTRCPLEN_P</function>, <function>Z_USTRLEN_P</function>,
and <function>Z_USTRVAL_P</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="zend-macro.z-bval-pp">
<refnamediv>
<refname>Z_BVAL_PP</refname>
@ -14,7 +14,9 @@
<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>
@ -26,7 +28,7 @@
<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>
@ -37,10 +39,35 @@
<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