$Web Flush - Revision history

DmeWiccan: Automatically generated page update

2013-04-09T15:50:59Z

Automatically generated page update

← Older revision		Revision as of 15:50, 9 April 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:$Web_Flush}}		{{DISPLAYTITLE:$Web_Flush}}
	<span class="pageSubtitle"~~><section begin="desc" /~~>Clear contents of Web response buffer~~<section end="desc" />~~</span>		<span class="pageSubtitle">Clear contents of Web response buffer</span>

	<var>$Web_Flush</var> clears the contents of the client buffer.		<var>$Web_Flush</var> clears the contents of the client buffer.
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~><span class="term">%rc</span> <span class="literal">= $Web_Flush</span>		<p class="syntax"><span class="term">%rc</span> <span class="literal">= $Web_Flush</span>
	~~<section end="syntax" />~~</p>		</p>

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

JAL: /* Examples */

2012-10-17T21:38:00Z

Examples

← Older revision		Revision as of 21:38, 17 October 2012
Line 35:		Line 35:
	<p class="code">ON FIND CONFLICT		<p class="code">ON FIND CONFLICT

	%X = $Web_Flush		%x = $Web_Flush
	%X = $Web_Type('text/HTML')		%x = $Web_Type('text/HTML')
	%X = $Web_ProcSend( 'WEBFILE', 'OFC.HTML' )		%x = $Web_ProcSend( 'WEBFILE', 'OFC.HTML' )
	STOP		STOP

Line 43:		Line 43:
	</p>		</p>
	<p>		<p>
	In the above example, <var>$Web_Flush</var> is used in an ON unit to clear any information in the client buffer before the content type is set and the static HTML in procedure 'OFC.HTML' is sent to the client. </p>		In the above example, <var>$Web_Flush</var> is used in an <var>ON</var> unit to clear any information in the client buffer before the content type is set and the static HTML in procedure <code>OFC.HTML</code> is sent to the client. </p>

	==See also==		==See also==

JAL: /* Syntax */

2012-10-17T21:36:13Z

Syntax

← Older revision		Revision as of 21:36, 17 October 2012
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<p class="syntax"><section begin="syntax" />%rc = $Web_Flush		<p class="syntax"><section begin="syntax" /><span class="term">%rc</span> <span class="literal">= $Web_Flush</span>
	<section end="syntax" /></p>		<section end="syntax" /></p>

	===~~Status codes~~===		===Syntax terms===
			<table class="syntaxTable">
			<tr><th>%rc</th>
			<td>A numeric status code:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>Code</th>		<tr><th>Code</th>
Line 18:		Line 21:
	<tr><th>-1</th>		<tr><th>-1</th>
	<td>Not a web thread</td></tr>		<td>Not a web thread</td></tr>
			</table>
			</td></tr>
	</table>		</table>

JALWiccan: 1 revision

2012-10-17T00:31:16Z

1 revision

← Older revision	Revision as of 00:31, 17 October 2012
(No difference)

JALWiccan: 1 revision

2012-10-17T00:31:14Z

1 revision

← Older revision		Revision as of 00:31, 17 October 2012
Line 2:		Line 2:
	<span class="pageSubtitle"><section begin="desc" />Clear contents of Web response buffer<section end="desc" /></span>		<span class="pageSubtitle"><section begin="desc" />Clear contents of Web response buffer<section end="desc" /></span>

	$Web_Flush clears the contents of the client buffer.		<var>$Web_Flush</var> clears the contents of the client buffer.

	$Web_Flush takes no arguments and returns a numeric status code. It is a [[Calling_Sirius_Mods_$functions\|callable]] $function.		<var>$Web_Flush</var> takes no arguments and returns a numeric status code. It is a [[Calling_Sirius_Mods_$functions\|callable]] $function.

	==Syntax==		==Syntax==
Line 22:		Line 22:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Everything sent to a client is buffered and sent at the completion of the request. This allows lines to be put to the client buffer (CCATEMP) from many points in the application, and the send to be performed once. $Web_Flush clears the client buffer and allows the application to begin building the buffer over again from scratch.		<li>Everything sent to a client is buffered and sent at the completion of the request. This allows lines to be put to the client buffer (CCATEMP) from many points in the application, and the send to be performed once. <var>$Web_Flush</var> clears the client buffer and allows the application to begin building the buffer over again from scratch.

	<li>Use $Web_Flush when the application detects an error and needs to change the sent content.		<li>Use <var>$Web_Flush</var> when the application detects an error and needs to change the sent content.
	</ul>		</ul>

Line 38:		Line 38:
	</p>		</p>
	<p>		<p>
	In the above example, $Web_Flush is used in an ON unit to clear any information in the client buffer before the content type is set and the static HTML in procedure 'OFC.HTML' is sent to the client. </p>		In the above example, <var>$Web_Flush</var> is used in an ON unit to clear any information in the client buffer before the content type is set and the static HTML in procedure 'OFC.HTML' is sent to the client. </p>

	==See also==		==See also==

JALWiccan: 1 revision

2012-10-16T23:37:45Z

1 revision

← Older revision	Revision as of 23:37, 16 October 2012
(No difference)

JAL at 23:37, 16 October 2012

2012-10-16T23:37:43Z

← Older revision		Revision as of 23:37, 16 October 2012
Line 13:		Line 13:
	<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>Completed successfully</td></tr>		<td>Completed successfully</td></tr>

JAL at 23:12, 12 October 2012

2012-10-12T23:12:18Z

← Older revision		Revision as of 23:12, 12 October 2012
Line 2:		Line 2:
	<span class="pageSubtitle"><section begin="desc" />Clear contents of Web response buffer<section end="desc" /></span>		<span class="pageSubtitle"><section begin="desc" />Clear contents of Web response buffer<section end="desc" /></span>

			$Web_Flush clears the contents of the client buffer.

			$Web_Flush takes no arguments and returns a numeric status code. It is a [[Calling_Sirius_Mods_$functions\|callable]] $function.

	~~$Web_Flush clears the contents of the client buffer.~~
	==Syntax==		==Syntax==
	<p class="syntax"><section begin="syntax" /> %RC = $Web_Flush		<p class="syntax"><section begin="syntax" />%rc = $Web_Flush
	<section end="syntax" /></p>		<section end="syntax" /></p>

			===Status codes===
	~~$Web_Flush takes no arguments and returns a numeric status code. It is a callable $function (see [[Calling_Sirius_Mods_$functions\|"Calling Sirius Mods $functions"]]).~~
	<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>
	~~<p class="caption">$WEB_FLUSH return codes</p>~~

			==Usage notes==
			<ul>
			<li>Everything sent to a client is buffered and sent at the completion of the request. This allows lines to be put to the client buffer (CCATEMP) from many points in the application, and the send to be performed once. $Web_Flush clears the client buffer and allows the application to begin building the buffer over again from scratch.

	Everything sent to a client is buffered and sent at the completion of the request. This allows lines to be put to the client buffer (CCATEMP) from many points in the application, and the send to be performed once. $Web_Flush ~~clears~~ the ~~client buffer~~ and ~~allows the application~~ to ~~begin building~~ the ~~buffer over again from scratch~~.		<li>Use $Web_Flush when the application detects an error and needs to change the sent content.
			</ul>

	~~Use $Web_Flush when the application detects an error and needs to change the sent content.~~		==Examples==
	<p class="code"> ON FIND CONFLICT		<p class="code">ON FIND CONFLICT

	%X = $Web_Flush		%X = $Web_Flush
	%X = $Web_Type('text/HTML')		%X = $Web_Type('text/HTML')
	%X = $Web_ProcSend( 'WEBFILE', 'OFC.HTML' )		%X = $Web_ProcSend( 'WEBFILE', 'OFC.HTML' )
	STOP		STOP

	END ON		END ON
	</p>		</p>
			<p>
			In the above example, $Web_Flush is used in an ON unit to clear any information in the client buffer before the content type is set and the static HTML in procedure 'OFC.HTML' is sent to the client. </p>

			==See also==
	~~In the above example, $Web_Flush is used in an ON unit to clear any information in the client buffer before the content type is set and the static HTML in procedure 'OFC.HTML' is sent to the client.~~		<ul>
			<li><var>[[$Web_Off]]</var> and <var>[[$Web_On]]</var>
	~~See also~~ [[$Web_Off]] and [[$Web_On]].		</ul>

	[[Category:Janus Web Server $functions\|$Web_Flush]]		[[Category:Janus Web Server $functions\|$Web_Flush]]

JALWiccan: 1 revision

2012-10-12T19:14:45Z

1 revision

← Older revision	Revision as of 19:14, 12 October 2012
(No difference)

Admin: 1 revision

2012-10-12T19:14:43Z

1 revision

← Older revision		Revision as of 19:14, 12 October 2012
Line 10:		Line 10:


	$Web_Flush takes no arguments and returns a numeric status code. It is a callable $function (see [[Calling_Sirius_Mods_$functions\|Calling Sirius Mods $functions]]).		$Web_Flush takes no arguments and returns a numeric status code. It is a callable $function (see [[Calling_Sirius_Mods_$functions\|"Calling Sirius Mods $functions"]]).
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>Code</th>		<tr><th>Code</th>