pollita Wed Nov 16 18:47:28 2005 EDT
Added files:
/phpdoc/en/reference/runkit/functions runkit-return-value-used.xml
Log:
Document runkit_return_value_used()
http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-return-value-used.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-return-value-used.xml
+++ phpdoc/en/reference/runkit/functions/runkit-return-value-used.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.runkit-return-value-used">
<refnamediv>
<refname>runkit_return_value_used</refname>
<refpurpose>Determines if the current functions return value will be
used</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit_return_value_used</methodname>
<void/>
</methodsynopsis>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the function's return value is used by the calling scope,
otherwise &false;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>runkit_return_value_used</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
function foo() {
var_dump(runkit_return_value_used());
}
foo();
$f = foo();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(false)
bool(true)
]]>
</screen>
</example>
</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
-->
