$Web_Expire

From m204wiki
Revision as of 20:25, 2 September 2014 by JAL (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Set expiration date/time of Web response


$Web_Expire sets the expiration date and time for the Web Server response entity being returned by the application. Using $Web_Expire, you can control how long a browser caches an entity returned by your application.

$Web_Expire requires one argument and returns a numeric status code. It is also callable.

Syntax

%rc = $Web_Expire( exp_time )

Syntax terms

exp_time A date/time expressed in seconds since 12 AM on January 1, 1900. You can use the $Web_DateNS function to get the current date in this format, and manipulate it using standard SOUL expressions.

Return codes

Code Meaning
0 Completed successfully
-1 Not a web thread
-4 Invalid datetime value

Examples

Use $Web_Expire to control how long a browser caches an entity returned by your application.

* Get current date in binary %x = $Web_DateNS * Add one week to the current date %x = %x + 7*24*60*60 * Ensure browser doesn't cache returned data * longer than one week %rc = $Web_Expire( %x ) * Changed my mind, only cache URL for 1 hour. * The previous $Web_Expire call is forgotten. %x = %x - (7*24-1)*60*60 %rc = $Web_Expire( %x )

In the above example, $Web_Expire is called to set the expiration date for the response entity. A second $Web_Expire demonstrates that you can override the $Web_Expire value any time you want.

See also