$Web On: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Resume adding terminal output to response<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Resume adding terminal output to response<section end="desc" /></span> | ||
$Web_On resumes the routing of terminal output to the client buffer. This buffer is sent to the client at the end of the connection. $Web_Off sends the output to the ''Model 204'' audit trail. | |||
$Web_On takes no arguments and returns a status code. It is a callable $function (see [[Calling_Sirius_Mods_$functions|Calling Sirius Mods $functions]]). | |||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %RC = $Web_On | <p class="syntax"><section begin="syntax" /> %RC = $Web_On | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
===Return codes=== | |||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>Code</th> | <tr><th>Code</th> | ||
| Line 18: | Line 18: | ||
<tr><th>-1</th> | <tr><th>-1</th> | ||
<td>Not a web thread</td></tr> | <td>Not a web thread</td></tr> | ||
</table> | </table> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li>Output lines that are returned to the client browser by a $Web_On statement are '''not''' wrapped or truncated if their length exceeds the ''Model 204'' LOBUFF parameter setting. Since some browsers do not render very long lines correctly (although no explicit guideline for "very long" is available), testing for your site's expected conditions and client browsers is advised if your output may contain such long lines with no CRLFs (line-wrapping breaks). | |||
</ul> | |||
==See also== | |||
<ul> | |||
<li><var>[[$Web_Off]]</var> | <li><var>[[$Web_Off]]</var> | ||
<li><var>[[$Web_Flush]]</var> | <li><var>[[$Web_Flush]]</var> | ||
Revision as of 15:33, 13 June 2012
<section begin="desc" />Resume adding terminal output to response<section end="desc" />
$Web_On resumes the routing of terminal output to the client buffer. This buffer is sent to the client at the end of the connection. $Web_Off sends the output to the Model 204 audit trail.
$Web_On takes no arguments and returns a status code. It is a callable $function (see Calling Sirius Mods $functions).
Syntax
<section begin="syntax" /> %RC = $Web_On <section end="syntax" />
Return codes
| Code | Meaning |
|---|---|
| 0 | Completed successfully. |
| -1 | Not a web thread |
Usage notes
- Output lines that are returned to the client browser by a $Web_On statement are not wrapped or truncated if their length exceeds the Model 204 LOBUFF parameter setting. Since some browsers do not render very long lines correctly (although no explicit guideline for "very long" is available), testing for your site's expected conditions and client browsers is advised if your output may contain such long lines with no CRLFs (line-wrapping breaks).