View source for $ScrHide

<span class="pageSubtitle">Hide lines in SCREEN</span>
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the screen $functions are the [[Screen classes#Screens and ScreenFields|Screen and ScreenField classes]].</p>

This [[Calling Sirius Mods $functions|callable]] function adjusts a <var>SCREEN</var> structure so that all fields after a specific line
number are hidden (not displayed) on subsequent <var>READ SCREEN</var> statements.
This makes it possible to build a screen that contains more lines than would fit
on all terminal models and then hide an appropriate number of lines based on
terminal model number.
The <var>$ScrHide</var> statement can also be used to provide space
for the <var>[[$ScrWide]]</var> function for Model 5 terminals.
 
==Syntax==
<p class="syntax">[%result =] $ScrHide(scr_name, line_num)
</p>

===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th>
<td>This numeric value indicates the function result. See [[#Status codes|"Status codes"]].</td></tr>

<tr><th>scr_name</th>
<td>The name of the screen on which fields are to be hidden.</td></tr>
 
<tr><th>line_num</th>
<td>The line number of the first line on the screen to be
hidden. Fields on this line number and all subsequent lines are hidden. </td></tr>
</table>

===Status codes===
<p class="code">0 &mdash; No errors
1 &mdash; SCREEN does not exist or invalid screen name
2 &mdash; Invalid line number
</p>
 
==Examples==
<ol>
<li>This code fragment hides all lines after line 24 on screen <code>INPUT</code>:
<p class="code">[%rc =] $scrhide('INPUT', 24)
</p>

<li>Using <var>$ScrHide</var>, <var>$ScrWide</var> and <var>[[$ScrSize]]</var> you can expand the number and
size of 3270 screen lines available to your <var class="product">User Language</var> programs to
the maximum that will fit on the terminal type.
Here is an example technique for presenting as much information as the user's screen can contain:
<p class="code">SCREEN USER1
&#42; Line  02:
PROMPT '===>'    WHITE    AT 2 -
INPUT  COMMAND   GREEN    AT 7 LEN 40
&#42; Line  03:
PROMPT LINE1              AT 2 LEN 77
&#42; Line  04:
PROMPT LINE2              AT 2 LEN 77
 ...
&#42; Line  44:
PROMPT LINE42             AT 2 LEN 77
&#42; Line  45:
PROMPT LINE43             AT 2 LEN 77
END SCREEN
%SCR.LENGTH = 24
%SCR.WIDTH  = 80
%SCR.MODEL  = $VIEW('MODEL')
JUMP TO (MOD0, MOD0, MOD3, MOD4, MOD5) %SCR.MODEL
JUMP TO MOD0
 
MOD3:  %SCR.LENGTH = 32
        JUMP TO MOD0
MOD4:  %SCR.LENGTH = 43
       JUMP TO MOD0
MOD5:  %SCR.LENGTH = 27
       %SCR.WIDTH  = 132
MOD0:  %MAX.WIDTH  = %SCR.WIDTH - 3
%X = $SCRHIDE( 'USER1' , %SCR.LENGTH )
%X = $SCRWIDE( 'USER1' )
%SCROLL.LEN = %SCR.LENGTH - 7
FOR %X FROM 1 TO %SCROLL.LEN + 1
   %LINE = 'USER1:LINE' WITH %X
   %X = $SCRSIZE( %LINE , %SCR.WIDTH )
END FOR
</p>
</ol>
 
==Products authorizing $ScrHide==
<ul class="smallAndTightList">
<li><var class="product">Sirius Functions</var>
</ul>

[[Category:$Functions|$ScrHide]]