$Web Put Text: Difference between revisions

From m204wiki
Jump to navigation Jump to search
No edit summary
(Automatically generated page update)
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> sends a text string to the client buffer.
Line 7: Line 7:


==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /><span class="term">%rc</span> = $Web_Put_Text( string )
<p class="syntax"><span class="term">%rc</span> = $Web_Put_Text( string )
<section end="syntax" /></p>
</p>


===Syntax terms===
===Syntax terms===

Revision as of 18:18, 10 April 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.