php-doc-en/reference/newt/functions/newt-run-form.xml
Michael Spector 1f541bd2c1 - organized constants
- documented some form functions


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@198850 c90b9560-bf6c-de11-be94-00142212c4b1
2005-10-20 12:51:15 +00:00

81 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.newt-run-form">
<refnamediv>
<refname>newt_run_form</refname>
<refpurpose>Runs a form</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>newt_run_form</methodname>
<methodparam><type>resource</type><parameter>form</parameter></methodparam>
</methodsynopsis>
<para>
This function runs the form passed to it.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>form</parameter></term>
<listitem>
<para>
Form component
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The component which caused the form to stop running.
</para>
<note>
<para>
Notice that this function doesn't fit in with newt's normal naming
convention. It is an older interface which will not work for all forms. It
was left in newt only for legacy applications. It is a simpler interface
than the new <function>newt_form_run</function> though, and is still used quite often as a
result. When an application is done with a form, it destroys the form and
all of the components the form contains.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>newt_form_run</function></member>
<member><function>newt_form_destroy</function></member>
</simplelist>
</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
-->