$Web NoCache: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Automatically generated page update)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$Web_NoCache}}
{{DISPLAYTITLE:$Web_NoCache}}
<span class="pageSubtitle"><section begin="desc" />Set HTTP response headers so fresh page displayed<section end="desc" /></span>
<span class="pageSubtitle">Set HTTP response headers so fresh page displayed</span>


<var>$Web_NoCache</var> sets various HTTP response headers so that the browser will display the new version of the response page, regardless of any cached versions.


<var>$Web_NoCache</var> does not take any arguments and it returns a numeric status code. It is a [[Calling Sirius Mods $functions|callable]] $function.


$Web_NoCache sets various HTTP response headers so that the browser will display the new version of the response page, regardless of any cached versions.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" />%rc = $Web_NoCache
<p class="syntax"><span class="term">%rc</span> = $Web_NoCache
<section end="syntax" /></p>
</p>


 
===Syntax terms===
$Web_NoCache does not take any arguments and it returns a numeric status code. It is a callable $function (see [[Calling_Sirius_Mods_$functions|"Calling Sirius Mods $functions"]]).
<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>
<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>
<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>
<p class="caption">$WEB_NOCACHE return codes</p>


==Usage notes==
<var>$Web_NoCache</var> is useful if you know that the page contains new information that the web user should see.


$Web_NoCache is useful if you know that the page contains new information that the web user should see.
==Examples==
<p class="code"> * Ensure new version of page is seen:
<p class="code">* Ensure new version of page is seen:
   
   
%X = $Web_NoCache
%X = $Web_NoCache
</p>
</p>


$Web_NoCache is only available in Versions 6.3 and later of the ''[[Sirius Mods]]''.


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

Latest revision as of 18:18, 10 April 2013

Set HTTP response headers so fresh page displayed

$Web_NoCache sets various HTTP response headers so that the browser will display the new version of the response page, regardless of any cached versions.

$Web_NoCache does not take any arguments and it returns a numeric status code. It is a callable $function.

Syntax

%rc = $Web_NoCache

Syntax terms

%rc A numeric status code:
Code Meaning
0 Completed successfully
-1 Not a web thread

Usage notes

$Web_NoCache is useful if you know that the page contains new information that the web user should see.

Examples

* Ensure new version of page is seen: %X = $Web_NoCache