$Web Screen: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 7: Line 7:
<section end="syntax" /></p>
<section end="syntax" /></p>


$Web_Screen is a callable $function (see [[Calling_Sirius_Mods_$functions|"Calling Sirius Mods $functions"]]).  
$Web_Screen is a [[Calling_Sirius_Mods_$functions|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.
$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 terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>parameter</th>
<tr><th>parameter</th>
Line 17: Line 19:
</td></tr></table>
</td></tr></table>


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 <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.
==Usage notes==
<ul>
<li>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.  
 
<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.
</ul>


<p class="code"> * Set some function key values
==Examples==
%JUNK = $Web_Screen('PF1', 'Help')
<ol>
%JUNK = $Web_Screen('PF3', 'Quit')
<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.
%JUNK = $Web_Screen('PF7', 'Down')
<p class="code">* Set some function key values
%JUNK = $Web_Screen('PF8', 'Up')
%JUNK = $Web_Screen('PF1', 'Help')
%JUNK = $Web_Screen('PF3', 'Quit')
%JUNK = $Web_Screen('PF7', 'Down')
%JUNK = $Web_Screen('PF8', 'Up')
</p>
</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.


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:
<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')
<p class="code">%JUNK = $Web_Screen(, 'NOCSSINSP')
%JUNK = $Web_Screen('LEGBL', 'LEGBL')
%JUNK = $Web_Screen('LEGBL', 'LEGBL')
%JUNK = $Web_Screen(, 'CSSTITLESPAN')
%JUNK = $Web_Screen(, 'CSSTITLESPAN')
</p>
</p>
 
<p>
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:
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>
<p class="code"> %JUNK = $Web_Screen('NOCSSINSP')
<p class="code">%JUNK = $Web_Screen('NOCSSINSP')
</p>
</p>
 
<p>
This statement would set %JUNK to either CSSTITLEDIV or CSSTITLESPAN, depending on the old setting of this parameter:
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')
<p class="code">%JUNK = $Web_Screen(,'CSSTITLEDIV')
</p>
</p>
</ol>


[[Category:Janus Web Server $functions|$Web_Screen]]
[[Category:Janus Web Server $functions|$Web_Screen]]

Revision as of 19:54, 16 October 2012

<section begin="desc" />Set 3270 to HTML mapping options<section end="desc" />

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

Syntax

<section begin="syntax" /> %CURVAL = $Web_Screen( parameter, value ) <section end="syntax" />

$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 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 .
value The new value for the parameter. These are the same values that can be set via JANUS WEB SCREEN rules, as documented in .

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

  1. 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')


  2. 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')

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Web_Screen&oldid=37130"