$Web Put Text: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 23: Line 23:
<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>

Revision as of 23:37, 16 October 2012

<section begin="desc" />Add text string to response buffer<section end="desc" />

$Web_Put_Text sends a text string to the client buffer.

$Web_Put_Text is a callable $function (see "Calling Sirius Mods $functions"), and it takes a single required string argument and returns a status code.

Syntax

<section begin="syntax" />%rc = $Web_Put_Text( string ) <section end="syntax" />

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_ProcSend) 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