Read (Screen function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax table to syntax template; edits, tags and links)
Line 17: Line 17:


==Examples==
==Examples==
For an example using the Read method, see [[Screen Object Sample Code]].
<ol><li>For an example using the <var>Read</var> method, see [[Screen Object Sample Code|"Screen Object Sample Code"]].</ol>


==See also==
==See also==
{{Template:Screen:Read footer}}
{{Template:Screen:Read footer}}

Revision as of 06:52, 26 June 2011

Write screen to display and return response (Screen class)

The Read Callable-function does the actual write of the screen to the "terminal," and it invokes a Model 204 wait while the user responds to the displayed screen. It then reads from the terminal the subsequent user response and updates the values of any modified ScreenField objects.

Syntax

[%key =] screen:Read Throws ScreenReadError

Syntax terms

%key A declared actionKey enumeration set to the identifier of the key that activated the reading of the screen. Valid values (case unimportant) are Enter and pf1, pf2, and so on through pf24.
screen A reference to an instance of a Screen object.

Usage notes

  • The Modified property is reset for all non-protected ScreenFields after the Read method is invoked. If a particular ScreenField value has been modified by the user, the Modified property for that field is set to True. Otherwise, the Modified property is set to False.

Examples

  1. For an example using the Read method, see "Screen Object Sample Code".

See also