form

NEWT_FORM_RUN(3)							 1							  NEWT_FORM_RUN(3)

newt_form_run - Runs a form

SYNOPSIS

       void newt_form_run (resource  $form, array  &$exit_struct)

DESCRIPTION

	This function runs the form passed to it.

PARAMETERS

	      o $form
		- Form component

	      o $exit_struct
		- Array, used for returning information after running the form component. Keys and values are described in the following table:

	      Form Exit Structure

	      +----------+--------------------------------------+---+
	      |Index Key |					|   |
	      | 	 |					|   |
	      | 	 |		Value Type		|   |
	      | 	 |					|   |
	      | 	 |	       Description		|   |
	      | 	 |					|   |
	      +----------+--------------------------------------+---+
	      | reason	 |					|   |
	      | 	 |					|   |
	      | 	 |		 integer		|   |
	      | 	 |					|   |
	      | 	 |  The  reason,  why the form has been |   |
	      | 	 | exited. Possible values are	defined |   |
	      | 	 | here.				|   |
	      | 	 |					|   |
	      |  watch	 |					|   |
	      | 	 |					|   |
	      | 	 |		 resource		|   |
	      | 	 |					|   |
	      | 	 | Resource    link,	specified    in |   |
	      | 	 | newt_form_watch_fd(3)		|   |
	      | 	 |					|   |
	      |   key	 |					|   |
	      | 	 |					|   |
	      | 	 |		 integer		|   |
	      | 	 |					|   |
	      | 	 |		  Hotkey		|   |
	      | 	 |					|   |
	      |component |					|   |
	      | 	 |					|   |
	      | 	 |		 resource		|   |
	      | 	 |					|   |
	      | 	 | Component, which caused the form  to |   |
	      | 	 | exit 				|   |
	      | 	 |					|   |
	      +----------+--------------------------------------+---+
RETURN VALUES

	No value is returned.

SEE ALSO

       newt_run_form(3).

PHP Documentation Group 													  NEWT_FORM_RUN(3)