View source for $Web Off

{{DISPLAYTITLE:$Web_Off}}
<span class="pageSubtitle"><section begin="desc" />Suspend adding terminal output to response<section end="desc" /></span>


<var>$Web_Off</var> suspends adding terminal output to the client buffer.

<var>$Web_Off</var> takes no arguments and returns a status code. 

==Syntax==
<p class="syntax"><section begin="syntax" /><span class="term">%rc</span> = $Web_Off
<section end="syntax" /></p>

===Return codes===
<table>
<tr><th>Code</th>
<th>Meaning</th></tr>
<tr><th>0</th>
<td>Completed successfully.</td></tr>
<tr><th>-1</th>
<td>Not a web thread</td></tr>
</table>

==Usage notes==
<ul>
<li><var>$Web_Off</var> may be invoked using the keyword CALL instead of assigning it to a %variable. For more information, see [[Calling_Sirius_Mods_$functions|"Calling Sirius Mods $functions"]]. 

<li>Web-connected clients have their terminal output routed either to the buffer that will be sent to them at the end of the connection, or to the <var class="product">Model 204</var> audit trail. During execution of a JANUS WEB ON ... CMD action, PRINT statements, command output, and error messages are normally translated from EBCDIC to ASCII and added to the client buffer. 

<li><var>$Web_Off</var> is called to selectively prevent terminal output from being added to the client buffer. 

During initial processing for <var class="product">[[Janus Web Server]]</var>, the state is <var>$Web_Off</var>, preventing output from OPEN FILE, OPEN GROUP, or CMD commands on the JANUS DEFINE command from being routed to the client buffer. 

If the selected JANUS WEB ON rule specifies a CMD sub-command, the state is changed to <var>$Web_On</var>, which allows terminal output from commands and PRINT statements to display at the browser.
</ul>

==Examples==
This example shows terminal output for an OPEN FILE command being redirected to the audit trail by the preceding <var>$Web_Off</var>, then output being redirected to the client buffer again in the request continuation with a <var>$Web_On</var>: 
<p class="code">B
%X = $Web_Off
END
 
OPEN FILE WORK
&#42;******
 
B
%X = $Web_On
</p>

==See also==
<ul>
<li><var>[[$Web_On]]</var>
<li><var>[[$Web_Flush]]</var> 
<li><var>[[$Web_Put_Text]]</var>
</ul>

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