$Web Off: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Automatically generated page update)
 
(22 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$Web_Off}}
{{DISPLAYTITLE:$Web_Off}}
<span class="pageSubtitle"><section begin="desc" />Suspend adding terminal output to response<section end="desc" /></span>
<span class="pageSubtitle">Suspend adding terminal output to response</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.


$Web_Off suspends adding terminal output to the client buffer.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RC = $Web_Off
<p class="syntax"><span class="term">%rc</span> = $Web_Off
<section end="syntax" /></p>
</p>
 


$Web_Off takes no arguments and returns a status code. It is a callable $function (see [[Calling_Sirius_Mods_$functions|Calling Sirius Mods $functions]]).
===Return codes===
<table class="syntaxTable">
<table>
<tr><th>Code</th>
<tr><th>Code</th>
<td>Meaning</td></tr>
<th>Meaning</th></tr>
<tr><th>0</th>
<tr><th>&nbsp;&nbsp;0</th>
<td>Completed successfully.</td></tr>
<td>Completed successfully.</td></tr>
<tr><th>-1</th>
<tr><th>-1</th>
<td>Not a web thread</td></tr>
<td>Not a web thread</td></tr>
</table>
</table>
<p class="caption">$WEB_OFF return codes</p>


==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"]].


$Web_Off 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.  


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 ''Model 204'' 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.  


$Web_Off 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.  


During initial processing for ''[[Janus Web Server]]'', the state is $WEB_OFF, 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>


If the selected JANUS WEB ON rule specifies a CMD sub-command, the state is changed to $WEB_ON, which allows terminal output from commands and PRINT statements to display at the browser.
==Examples==
<p class="code"> B
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>:
%X = $Web_Off
<p class="code">B
END
%X = $Web_Off
END
   
   
OPEN FILE WORK
OPEN FILE WORK
*******
&#42;******
   
   
B
B
%X = $Web_On
%X = $Web_On
</p>
</p>


 
==See also==
The example above shows terminal output for an OPEN FILE command being redirected to the audit trail by the preceding $WEB_OFF, then output being redirected to the client buffer again in the request continuation with a $Web_On.
<ul>
 
<li><var>[[$Web_On]]</var>
For more information related to $Web_Off processing, see:<ul>  
<li><var>[[$Web_Flush]]</var>
<li>[[$Web_On]], below
<li><var>[[$Web_Put_Text]]</var>
<li>[[$Web_Flush]]  
</ul>
<li>[[$Web_Put_Text]]</ul>


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

Latest revision as of 18:18, 10 April 2013

Suspend adding terminal output to response


$Web_Off suspends adding terminal output to the client buffer.

$Web_Off takes no arguments and returns a status code.

Syntax

%rc = $Web_Off

Return codes

Code Meaning
  0 Completed successfully.
-1 Not a web thread

Usage notes

  • $Web_Off may be invoked using the keyword CALL instead of assigning it to a %variable. For more information, see "Calling Sirius Mods $functions".
  • 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 Model 204 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.
  • $Web_Off is called to selectively prevent terminal output from being added to the client buffer. During initial processing for Janus Web Server, the state is $Web_Off, 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 $Web_On, which allows terminal output from commands and PRINT statements to display at the browser.

Examples

This example shows terminal output for an OPEN FILE command being redirected to the audit trail by the preceding $Web_Off, then output being redirected to the client buffer again in the request continuation with a $Web_On:

B %X = $Web_Off END OPEN FILE WORK ******* B %X = $Web_On

See also

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