$Web Put Text: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(23 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$Web_Put_Text}}
{{DISPLAYTITLE:$Web_Put_Text}}
<span class="pageSubtitle"><section begin="desc" />Add text string to response buffer<section end="desc" /></span>
<span class="pageSubtitle">Add text string to response buffer</span>
 
<var>$Web_Put_Text</var> sends a text string to the client buffer.
 
<var>$Web_Put_Text</var> is a [[Calling Sirius Mods $functions|callable]] $function, and it takes a single required string argument and returns a status code.


$Web_Put_Text sends a text string to the client buffer.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RC = $Web_Put_Text( string )
<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Web_Put_Text</span>(<span class="term"> string</span> )
<section end="syntax" /></p>
</p>


$Web_Put_Text is a callable $function (see [[Calling_Sirius_Mods_$functions|Calling Sirius Mods $functions]]), and it takes a single required string argument and returns a status code.
===Syntax terms===
<table class="syntaxTable">
<tr><th>%rc</th>
<td>A numeric [[#Status codes|status code]].


<table class="syntaxTable">
<tr><th>string</th>
<tr><th>string</th>
<td>A text string that is translated from EBCDIC to ASCII and added to the client buffer.  Under ''[[Sirius Mods]]'' Version 6.7 and later, $Web_Put_Text is longstring capable: it can send a longstring with a length greater than 255 bytes.
<td>A text string that is translated from EBCDIC to ASCII and added to the client buffer.  Under ''[[Sirius Mods]]'' Version 6.7 and later, <var>$Web_Put_Text</var> is longstring capable: it can send a longstring with a length greater than 255 bytes.
</td></tr>
</td></tr>
</table>
</table>


===Status codes===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>Code</th>
<tr><th>Code</th>
<td>Meaning</td></tr>
<th>Meaning</th></tr>
<tr><th>0</th>
<tr><th>0</th>
<td>String sent to the client buffer.</td></tr>
<td>String sent to the client buffer.</td></tr>
Line 25: Line 31:
<td>Missing argument</td></tr>
<td>Missing argument</td></tr>
</table>
</table>
<p class="caption">$WEB_PUT_TEXT return codes</p>


For example:
==Usage notes==
The primary uses for <var>$Web_Put_Text</var> are:
<ul>
<li>To send text to a browser when [[$Web_Off]] is set: it might be easier to do a <var>$Web_Put_Text</var> than a [[$Web_On]], PRINT, [[$Web_Off]] sequence.
<li>To have text that is to be sent to a browser embedded in code that is also used in non-browser (for example, 3270 or BATCH2) mode. <var>$Web_Put_Text</var> acts as a no-op when executed on a non-web thread so can be used instead of an IF test (to determine if running on a web thread) followed by a PRINT statement.
</ul>


<p class="code"> %X = $Web_Type('text/HTML')
==Examples==
%X = $Web_Put_Text( '<HTML>' )
The following example shows an entire HTML document being sent to the client, a line at a time. Note that you could also direct HTML to the client by sending a procedure that contains HTML (using <var>[[$Web_Proc_Send]]</var>) or simply with PRINT statements (unless <var>$Web_Off</var> has been issued).
%X = $Web_Put_Text( '<p>' )
 
%X = $Web_Put_Text( 'Hello World' )
<p class="code">%X = $Web_Type('text/HTML')
%X = $Web_Put_Text( '</HTML>' )
%X = $Web_Put_Text( '<HTML>' )
STOP
%X = $Web_Put_Text( '<p>' )
%X = $Web_Put_Text( 'Hello World' )
%X = $Web_Put_Text( '</HTML>' )
STOP
</p>
</p>
 
==See also==
The above example shows an entire HTML document being sent to the client, a line at a time. Note that you could also direct HTML to the client by sending a procedure that contains HTML (using [[$Web_ProcSend]]) or simply with PRINT statements (unless $Web_Off has been issued).
<ul>
 
<li><li><var>[[$Web_Proc_Send]]</var> can be used to send the contents of a <var class="product">Model 204</var> procedure, either as binary (that is, without translation) or translating from EBCDIC to ASCII.
The two primary uses for $Web_Put_Text are
<li><var>[[$Web_Put_Binary]]</var> adds a string to the web output buffer without translation.
 
</ul>
<ol>
<li>To send text to a browser when [[$Web_Off]] is set: it might be easier to do a $Web_Put_Text than a [[$Web_On]], PRINT, [[$Web_Off]] sequence.
<li>To have text that is to be sent to a browser embedded in code that is also used in non-browser (for example, 3270 or BATCH2) mode. $Web_Put_Text acts as a no-op when executed on a non-web thread so can be used instead of an IF test (to determine if running on a web thread) followed by a PRINT statement.
</ol>


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

Latest revision as of 22:09, 5 June 2013

Add text string to response buffer

$Web_Put_Text sends a text string to the client buffer.

$Web_Put_Text is a callable $function, and it takes a single required string argument and returns a status code.

Syntax

%rc = $Web_Put_Text( string )

Syntax terms

%rc A numeric status code.
string A text string that is translated from EBCDIC to ASCII and added to the client buffer. Under Sirius Mods Version 6.7 and later, $Web_Put_Text is longstring capable: it can send a longstring with a length greater than 255 bytes.

Status codes

Code Meaning
0 String sent to the client buffer.
-1 Invalid call, not a Web thread
-4 Missing argument

Usage notes

The primary uses for $Web_Put_Text are:

  • To send text to a browser when $Web_Off is set: it might be easier to do a $Web_Put_Text than a $Web_On, PRINT, $Web_Off sequence.
  • To have text that is to be sent to a browser embedded in code that is also used in non-browser (for example, 3270 or BATCH2) mode. $Web_Put_Text acts as a no-op when executed on a non-web thread so can be used instead of an IF test (to determine if running on a web thread) followed by a PRINT statement.

Examples

The following example shows an entire HTML document being sent to the client, a line at a time. Note that you could also direct HTML to the client by sending a procedure that contains HTML (using $Web_Proc_Send) or simply with PRINT statements (unless $Web_Off has been issued).

%X = $Web_Type('text/HTML') %X = $Web_Put_Text( '<HTML>' ) %X = $Web_Put_Text( '

' ) %X = $Web_Put_Text( 'Hello World' ) %X = $Web_Put_Text( '</HTML>' ) STOP

See also

  • $Web_Proc_Send can be used to send the contents of a Model 204 procedure, either as binary (that is, without translation) or translating from EBCDIC to ASCII.
  • $Web_Put_Binary adds a string to the web output buffer without translation.