$Web Output Content: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Usage notes) |
||
| Line 27: | Line 27: | ||
==Usage notes== | ==Usage notes== | ||
$Web_Output_Content can be used to examine data in the ''[[Janus Web Server]]'' output stream that results from Print or Html/Text statements when web capture is on ($Web_On), or to examine data that results from $ | <ul> | ||
<li>$Web_Output_Content can be used to examine data in the ''[[Janus Web Server]]'' output stream that results from Print or Html/Text statements when web capture is on ($Web_On), or to examine data that results from <var>[[$Web_Proc_Send]]</var>. | |||
$Web_Output_Content cannot examine output data in these cases: | $Web_Output_Content cannot examine output data in these cases: | ||
<ul> | <ul> | ||
<li>After a <var>$Web_Done</var> | <li>After a <var>$Web_Done</var> | ||
| Line 37: | Line 37: | ||
</ul> | </ul> | ||
Text data is typically translated from EBCDIC to ASCII when sent to the ''[[Janus Web Server]]'' output stream. When the <tt>Text</tt> option is used with $WEB_OUTPUT_CONTENT, the data is translated back. If the EBCDIC-to-ASCII and ASCII-to-EBCDIC translate tables are not completely symmetrical, it is possible that the results of $Web_Output_Content will not be exactly what was sent. | <li>Text data is typically translated from EBCDIC to ASCII when sent to the ''[[Janus Web Server]]'' output stream. When the <tt>Text</tt> option is used with $WEB_OUTPUT_CONTENT, the data is translated back. If the EBCDIC-to-ASCII and ASCII-to-EBCDIC translate tables are not completely symmetrical, it is possible that the results of $Web_Output_Content will not be exactly what was sent. | ||
<p> | |||
A particular translation problem is the pair of square bracket characters ([ ]), which has three different EBCDIC representations but only one ASCII representation. If the preferred EBCDIC square bracket values at a site are not the ones to which the default ASCII-to-EBCDIC translate table translates, the translate tables can be modified. For more information about this, see the "Translate Tables" chapter in the ''Janus TCP/IP Base Reference Manual''. </p> | |||
<p>'''Note:''' ASCII carriage returns (X'0D'), linefeeds (X'0A'), or both are added to the output stream for each text data output line (according to the CR, LF, or CRLF setting of JANUS DEFINE, JANUS WEB ON, or $Web_ProcSend). These characters get translated back to EBCDIC carriage returns (X'0D') and linefeeds (X'25') by $Web_Output_Content.</p> | |||
Having the output content as a single longstring might be inconvenient for many applications, especially if the data is line-oriented. It is the application's responsibility to parse this longstring using either longstring parsing functions | <li>Having the output content as a single longstring might be inconvenient for many applications, especially if the data is line-oriented. It is the application's responsibility to parse this [[Longstrings|longstring]] using either [[List of $functions|$Lstr_xxx]] longstring parsing functions or <var>Stringlist</var> class parsing methods — the <var>[[ParseLines (Stringlist function)|ParseLines]]</var> method is likely to be particularly helpful. | ||
</ul> | |||
==See also== | ==See also== | ||
Revision as of 15:48, 13 June 2012
<section begin="desc" />Retrieve current output stream<section end="desc" />
$Web_Output_Content retrieves the current contents of the Janus Web Server output stream as a longstring.
$Web_Output_Content takes a single optional argument and returns a longstring.
Syntax
<section begin="syntax" /> %LSTR = $Web_Output_Content( type ) <section end="syntax" />
Syntax terms
| type | A case-independent string set to one of the following:
type is an optional argument, and it defaults to Binary. |
|---|
Usage notes
- $Web_Output_Content can be used to examine data in the Janus Web Server output stream that results from Print or Html/Text statements when web capture is on ($Web_On), or to examine data that results from $Web_Proc_Send.
$Web_Output_Content cannot examine output data in these cases:
- After a $Web_Done
- After a $WEB_PROC_SEND without the MORE parameter
- After a $Web_Flush
- Text data is typically translated from EBCDIC to ASCII when sent to the Janus Web Server output stream. When the Text option is used with $WEB_OUTPUT_CONTENT, the data is translated back. If the EBCDIC-to-ASCII and ASCII-to-EBCDIC translate tables are not completely symmetrical, it is possible that the results of $Web_Output_Content will not be exactly what was sent.
A particular translation problem is the pair of square bracket characters ([ ]), which has three different EBCDIC representations but only one ASCII representation. If the preferred EBCDIC square bracket values at a site are not the ones to which the default ASCII-to-EBCDIC translate table translates, the translate tables can be modified. For more information about this, see the "Translate Tables" chapter in the Janus TCP/IP Base Reference Manual.
Note: ASCII carriage returns (X'0D'), linefeeds (X'0A'), or both are added to the output stream for each text data output line (according to the CR, LF, or CRLF setting of JANUS DEFINE, JANUS WEB ON, or $Web_ProcSend). These characters get translated back to EBCDIC carriage returns (X'0D') and linefeeds (X'25') by $Web_Output_Content.
- Having the output content as a single longstring might be inconvenient for many applications, especially if the data is line-oriented. It is the application's responsibility to parse this longstring using either $Lstr_xxx longstring parsing functions or Stringlist class parsing methods — the ParseLines method is likely to be particularly helpful.