$Web Screen: Difference between revisions

Latest revision as of 21:41, 5 June 2013

Set 3270 to HTML mapping options

$Web_Screen sets the value of 3270-screen-to-HTML mapping options and/or returns the current value of these options.

$Web_Screen is a callable $function.

$Web_Screen accepts two arguments, the first one required, and it returns a string containing the previous setting of the indicated parameter, or it returns a null for any errors.

Syntax

%curval = $Web_Screen( parameter, value )

Syntax terms

parameter	The name of a parameter that controls the conversion of 3270 screens to HTML. These are the same parameters that can be set via `JANUS WEB SCREEN` rules, as documented in `JANUS WEB SCREEN`.
value	The new value for the parameter. These are the same values that can be set via `JANUS WEB SCREEN` rules.

Usage notes

If the parameter name is missing or invalid or the value is invalid, $Web_Screen returns a null string. If the value argument is missing, $Web_Screen returns the current value of the indicated parameter. In all other cases, $Web_Screen sets the value of parameter to value, and it returns value to indicate success.
$Web_Screen only affects the settings for the current Janus Web Server Legacy session; it does not affect settings for other users or other sessions for the same user. It also does not affect the initial screen rules for subsequent Janus Web Legacy sessions.

Examples

In the following example, the labels for function keys 1, 3 , 7, and 8 are set for subsequent 3270 screens. The current settings for other function keys are unaffected.
* Set some function key values %JUNK = $Web_Screen('PF1', 'Help') %JUNK = $Web_Screen('PF3', 'Quit') %JUNK = $Web_Screen('PF7', 'Down') %JUNK = $Web_Screen('PF8', 'Up')
There are certain self-defining parameters for JANUS WEB SCREEN rules that don't have the parameter and value format but simply have a parameter name. Examples of this are CSSINSP, NOCSSINSP, LEGBL, and NOLEGBL. For these types of parameters, the parameter name is not required; if present, it must be the alternate value of that parameter:
%JUNK = $Web_Screen(, 'NOCSSINSP') %JUNK = $Web_Screen('LEGBL', 'LEGBL') %JUNK = $Web_Screen(, 'CSSTITLESPAN')

Also, for these types of parameters, the value returned by $Web_Screen will be one of the alternate values, so the following statement might set %JUNK to either CSSINSP or NOCSSINSP:

%JUNK = $Web_Screen('NOCSSINSP')

This statement would set %JUNK to either CSSTITLEDIV or CSSTITLESPAN, depending on the old setting of this parameter:

%JUNK = $Web_Screen(,'CSSTITLEDIV')

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:$Web_Screen}}
-<span class="pageSubtitle"><section begin="desc" />Set 3270 to HTML mapping options<section end="desc" /></span>
+<span class="pageSubtitle">Set 3270 to HTML mapping options</span>
+<var>$Web_Screen</var> sets the value of 3270-screen-to-HTML mapping options and/or returns the current value of these options.
+<var>$Web_Screen</var> is a [[Calling_Sirius_Mods_$functions|callable]] $function.
+<var>$Web_Screen</var> accepts two arguments, the first one required, and it returns a string containing the previous setting of the indicated parameter, or it returns a null for any errors.
-$Web_Screen sets the value of 3270-screen-to-HTML mapping options and/or returns the current value of these options.
 ==Syntax==
-<p class="syntax"><section begin="syntax" /> %CURVAL = $Web_Screen( parameter, value )
+<p class="syntax"><span class="term">%curval</span> = <span class="literal">$Web_Screen</span>( <span class="term">parameter</span>, <span class="term">value</span> )
-<section end="syntax" /></p>
+</p>
-$Web_Screen is a callable $function (see [[Calling_Sirius_Mods_$functions|Calling Sirius Mods $functions]]).
+===Syntax terms===
-$Web_Screen accepts two arguments, the first one required, and it returns a string containing the previous setting of the indicated parameter, or it returns a null for any errors.
 <table class="syntaxTable">
 <tr><th>parameter</th>
-<td>The name of a parameter that controls the conversion of 3270 screens to HTML. These are the same parameters that can be set via JANUS WEB SCREEN rules, as documented in .</td></tr>
+<td>The name of a parameter that controls the conversion of 3270 screens to HTML. These are the same parameters that can be set via <var>JANUS WEB SCREEN</var> rules, as documented in <var>[[JANUS WEB SCREEN]]</var>.</td></tr>
 <tr><th>value</th>
-<td>The new value for the parameter. These are the same values that can be set via JANUS WEB SCREEN rules, as documented in .
+<td>The new value for the parameter. These are the same values that can be set via <var>JANUS WEB SCREEN</var> rules.
 </td></tr></table>
+==Usage notes==
+<ul>
+<li>If the parameter name is missing or invalid or the value is invalid, <var>$Web_Screen</var> returns a null string. If the ''value'' argument is missing, <var>$Web_Screen</var> returns the current value of the indicated parameter. In all other cases, <var>$Web_Screen</var> sets the value of ''parameter'' to ''value'', and it returns ''value'' to indicate success.
-If the parameter name is missing or invalid or the value is invalid, $Web_Screen returns a null string. If the ''value'' argument is missing, $Web_Screen returns the current value of the indicated parameter. In all other cases, $Web_Screen sets the value of ''parameter'' to ''value'', and it returns ''value'' to indicate success. $Web_Screen only affects the settings for the current ''[[Janus Web Server]]'' Legacy session; it does not affect settings for other users or other sessions for the same user. It also does not affect the initial screen rules for subsequent Janus Web Legacy sessions.
+<li>$Web_Screen only affects the settings for the current <var class="product">[[Janus Web Server]]</var> Legacy session; it does not affect settings for other users or other sessions for the same user. It also does not affect the initial screen rules for subsequent Janus Web Legacy sessions.
-<p class="code"> * Set some function key values
+</ul>
- %JUNK = $Web_Screen('PF1', 'Help')
- %JUNK = $Web_Screen('PF3', 'Quit')
+==Examples==
- %JUNK = $Web_Screen('PF7', 'Down')
+<ol>
- %JUNK = $Web_Screen('PF8', 'Up')
+<li>In the following example, the labels for function keys 1, 3 , 7, and 8 are set for subsequent 3270 screens. The current settings for other function keys are unaffected.
+<p class="code">* Set some function key values
+%JUNK = $Web_Screen('PF1', 'Help')
+%JUNK = $Web_Screen('PF3', 'Quit')
+%JUNK = $Web_Screen('PF7', 'Down')
+%JUNK = $Web_Screen('PF8', 'Up')
 </p>
-In the above example, the labels for function keys 1, 3 , 7, and 8 are set for subsequent 3270 screens. The current settings for other function keys are unaffected.
+<li>There are certain self-defining parameters for JANUS WEB SCREEN rules that don't have the parameter and value format but simply have a parameter name. Examples of this are CSSINSP, NOCSSINSP, LEGBL, and NOLEGBL. For these types of parameters, the parameter name is not required; if present, it must be the alternate value of that parameter:
+<p class="code">%JUNK = $Web_Screen(, 'NOCSSINSP')
-There are certain self-defining parameters for JANUS WEB SCREEN rules that don't have the format parameter and value but simply have a parameter name. Examples of this are CSSINSP, NOCSSINSP, LEGBL, and NOLEGBL. For these types of parameters, the parameter name is not required; if present, it must be the alternate value of that parameter:
+%JUNK = $Web_Screen('LEGBL', 'LEGBL')
-<p class="code"> %JUNK = $Web_Screen(, 'NOCSSINSP')
+%JUNK = $Web_Screen(, 'CSSTITLESPAN')
- %JUNK = $Web_Screen('LEGBL', 'LEGBL')
- %JUNK = $Web_Screen(, 'CSSTITLESPAN')
 </p>
+<p>
+Also, for these types of parameters, the value returned by <var>$Web_Screen</var> will be one of the alternate values, so the following statement might set %JUNK to either CSSINSP or NOCSSINSP: </p>
+<p class="code">%JUNK = $Web_Screen('NOCSSINSP')
-Also, for these types of parameters, the value returned by $Web_Screen will be one of the alternate values, so the following statement might set %JUNK to either CSSINSP or NOCSSINSP:
-<p class="code"> %JUNK = $Web_Screen('NOCSSINSP')
 </p>
+<p>
+This statement would set %JUNK to either CSSTITLEDIV or CSSTITLESPAN, depending on the old setting of this parameter: </p>
+<p class="code">%JUNK = $Web_Screen(,'CSSTITLEDIV')
-This statement would set %JUNK to either CSSTITLEDIV or CSSTITLESPAN, depending on the old setting of this parameter:
-<p class="code"> %JUNK = $Web_Screen(,'CSSTITLEDIV')
 </p>
+</ol>
 [[Category:Janus Web Server $functions|$Web_Screen]]