$Web Sub: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Set delimiter for procedure text substitution<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Set delimiter for procedure text substitution<section end="desc" /></span> | ||
$Web_Sub sets the delimiter for designating text to be symbolically substituted when text is sent to the client from within ''Model 204'' procedures. | |||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %RC = $Web_Sub( delimiter ) | <p class="syntax"><section begin="syntax" /> %RC = $Web_Sub( delimiter ) | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
$Web_Sub is a callable $function (see [[Calling_Sirius_Mods_$functions|Calling Sirius Mods $functions]]), and it takes a single string argument and returns a status code. | |||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>delimiter</th> | <tr><th>delimiter</th> | ||
<td>A 1- to 3-character string, or a null string. | <td>A 1- to 3-character string, or a null string. | ||
</td></tr></table> | </td></tr> | ||
</table> | |||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 25: | Line 25: | ||
<tr><th>-4</th> | <tr><th>-4</th> | ||
<td>Invalid argument (more than 3 characters long)</td></tr> | <td>Invalid argument (more than 3 characters long)</td></tr> | ||
</table> | </table> | ||
<p class="caption">$WEB_SUB return codes</p> | <p class="caption">$WEB_SUB return codes</p> | ||
If not null, this delimiter is then used to identify the text strings in a ''Model 204'' procedure that should be symbolically substituted before presentation to the client. Strings that begin with the given delimiter and end with an exclamation mark ( ! ) will be matched against the Global Variable Table (GTBL), and the value of any such global variables will be substituted for the string. | If not null, this delimiter is then used to identify the text strings in a ''Model 204'' procedure that should be symbolically substituted before presentation to the client. Strings that begin with the given delimiter and end with an exclamation mark ( ! ) will be matched against the Global Variable Table (GTBL), and the value of any such global variables will be substituted for the string. | ||
| Line 35: | Line 33: | ||
Until $Web_Sub is called, ''[[Janus Web Server]]'' does not perform any substitution of strings into procedures sent to the client. Setting $Web_Sub to null also turns off substitution. | Until $Web_Sub is called, ''[[Janus Web Server]]'' does not perform any substitution of strings into procedures sent to the client. Setting $Web_Sub to null also turns off substitution. | ||
Here is a $Web_Sub example: | Here is a $Web_Sub example: | ||
<p class="code"> <HTML> | <p class="code"> <HTML> | ||
<p>Greetings from @LOCATION!. | <p>Greetings from @LOCATION!. | ||
<p>Having a @QUALITY! time. | <p>Having a @QUALITY! time. | ||
<p>Wish you were @WISHLOC!. | <p>Wish you were @WISHLOC!. | ||
</HTML> | </HTML> | ||
| Line 54: | Line 51: | ||
</p> | </p> | ||
In the example above, an at sign (<tt>@</tt>) is used as the substitution indicator for global names in procedure text. The client would see: | |||
<p class="code"> Greetings from Springfield. | <p class="code"> Greetings from Springfield. | ||
Having a nice time. | Having a nice time. | ||
Wish you were rich. | Wish you were rich. | ||
</p> | </p> | ||
As with all $WEB_ functions, $Web_Sub can be invoked by CMD processing, which is specified either in the ON rule for the URL or in the JANUS DEFINE ... WEB command for the port. Note that $Web_Sub can only affect procedures referenced in SEND rules if $Web_Sub is called due to the JANUS DEFINE ... WEB command. | As with all $WEB_ functions, $Web_Sub can be invoked by CMD processing, which is specified either in the ON rule for the URL or in the JANUS DEFINE ... WEB command for the port. Note that $Web_Sub can only affect procedures referenced in SEND rules if $Web_Sub is called due to the JANUS DEFINE ... WEB command. | ||
[[Category:Janus Web Server $functions|$Web_Sub]] | [[Category:Janus Web Server $functions|$Web_Sub]] | ||
Revision as of 15:41, 23 February 2011
<section begin="desc" />Set delimiter for procedure text substitution<section end="desc" />
$Web_Sub sets the delimiter for designating text to be symbolically substituted when text is sent to the client from within Model 204 procedures.
Syntax
<section begin="syntax" /> %RC = $Web_Sub( delimiter ) <section end="syntax" />
$Web_Sub is a callable $function (see Calling Sirius Mods $functions), and it takes a single string argument and returns a status code.
| delimiter | A 1- to 3-character string, or a null string. |
|---|
| Code | Meaning |
|---|---|
| 0 | Substitution delimiter successfully set. |
| -1 | Invalid call, not a Web thread |
| -4 | Invalid argument (more than 3 characters long) |
$WEB_SUB return codes
If not null, this delimiter is then used to identify the text strings in a Model 204 procedure that should be symbolically substituted before presentation to the client. Strings that begin with the given delimiter and end with an exclamation mark ( ! ) will be matched against the Global Variable Table (GTBL), and the value of any such global variables will be substituted for the string.
Symbolic substitution performed by the $Web_Sub setting only affects lines sent to the client by $Web_ProcSend or by the SEND subcommand in the ON rule chosen for the URL.
Until $Web_Sub is called, Janus Web Server does not perform any substitution of strings into procedures sent to the client. Setting $Web_Sub to null also turns off substitution.
Here is a $Web_Sub example:
<HTML>
Greetings from @LOCATION!.
Having a @QUALITY! time.
Wish you were @WISHLOC!. </HTML> . . . %X = $SETG('LOCATION','Springfield') %X = $SETG('QUALITY','nice') %X = $SETG('WISHLOC','rich') %X = $Web_Sub('@') %X = $Web_ProcSend( 'HTMLFILE', 'GREETING' )
In the example above, an at sign (@) is used as the substitution indicator for global names in procedure text. The client would see:
Greetings from Springfield. Having a nice time. Wish you were rich.
As with all $WEB_ functions, $Web_Sub can be invoked by CMD processing, which is specified either in the ON rule for the URL or in the JANUS DEFINE ... WEB command for the port. Note that $Web_Sub can only affect procedures referenced in SEND rules if $Web_Sub is called due to the JANUS DEFINE ... WEB command.