input_screen

Returns user input from all screen fields. Used for CGI applications.

Available in:

Apps (win) Apps (char) Reportwriter RPC Standalone PL
X X      

Syntax

void input_screen([validate[,form[,html_header[,html_leader[,html_trailer]]]]])
int    validate
int    form
expr   html_header
expr   html_leader
expr   html_trailer

Description

Updates the HTML page with the current field values. Reads the values into the field_d variables and optionally runs the validation triggers for all the fields. If the field values are valid, it moves them to the field variables.
validate (optional) If true, run the validation triggers for the fields. The default is false. Validate = true is similar to input(expr) whereas validate = false is similar to raw_input(expr).
form (optional) If true, then the HTML FORM from the file runfile.window_id.html is used for the screen, where runfile is the name of the application and window_id is the window ID. The HTML FORM file is generated by the dvhtml program. If false, then an internally generated FORM is used.
html_header (optional) This can be either a string with the name of the HTML file that contains the FORM page header or a list containing HTML for the header. The default is NULL.
html_leader (optional) This can be either a string with the name of the HTML file that contains the FORM page leader or a list containing HTML for the leader. The default is NULL.
html_trailer (optional) This can be either a string with the name of the HTML file that contains the FORM page trailer or a list containing HTML for the trailer. The default is NULL.
When an HTML file is used, the html_path in dv.ini is used to find the file.

Notes

The alarm setting, busy_alarm, in dv.ini helps you control a runaway query or looping function. For complete information, refer to dv.ini documentation in the DesignVision Users Guide or VORTEX Installation and Usage Guide.

Can only be used when in a field. An input_screen() call causes the following sequence of events:

  1. G.MODIFIED is set to false.
  2. G.INPUT_DATA is set to false.
  3. HTML page is populated with actual data.
  4. DVrun.cgi waits for user input (via DVnode).
  5. All modified data is moved into field_d variables.
  6. any_key trigger is executed if it exists.
  7. Pre-validation key trigger is executed.
  8. Validation triggers for all modified field are executed if requested.
  9. Post-validation key trigger is executed.
  10. Returns to caller.