$Web Del Sel: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 2: Line 2:
<span class="pageSubtitle"><section begin="desc" />Delete a global select element<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />Delete a global select element<section end="desc" /></span>


$Web_Del_Sel deletes a global select element, preventing its further use and freeing any CCATEMP pages used by it. An overview of the $Web_Sel* functions is provided in [[$Web_Selp]].


$Web_Del_Sel is a [[Calling_Sirius_Mods_$functions|callable]] $function, and it can be run from a non-<var class="product">[[Janus Web Server]]</var> thread.


$Web_Del_Sel deletes a global select element, preventing its further use and freeing any CCATEMP pages used by it. An overview of the $Web_Sel* functions is provided in [[$Web_Selp]].
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RC = $Web_Del_Sel(global_name)
<p class="syntax"><section begin="syntax" />%rc = $Web_Del_Sel(global_name)
<section end="syntax" /></p>
<section end="syntax" /></p>


 
===Syntax terms===
$Web_Del_Sel is a callable $function (see [[Calling_Sirius_Mods_$functions|"Calling Sirius Mods $functions"]]), and it can be run from a non-<var class="product">[[Janus Web Server]]</var> thread.
 
$Web_Del_Sel takes one argument and always returns zero.
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%rc</th>
<td>A numeric return code. 0 is always returned.
<tr><th>global_name</th>
<tr><th>global_name</th>
<td>The name of the global select element to delete. If it has not been saved by $WEB_SAVE_SEL, this routine does nothing.
<td>The name of the global select element to delete. If it has not been saved by $Web_Save_Sel, this routine does nothing.
</td></tr></table>
</td></tr></table>


<table class="syntaxTable">
==Usage notes==
<tr><th>Code</th>
<ul>
<td>Meaning</td></tr>
<li>$Web_Del_Sel will delete a global select element, preventing its further use; an example of this is shown in [[$Web_Selp]]. Other than this, $Web_Del_Sel is not needed to perform any processing supplied by the $WEB_SELx functions; unused global select elements will simply have their contents migrate out of the buffer pool and remain as unused CCATEMP pages.
<tr><th>0</th>
</ul>
<td>This is always returned.</td></tr>
 
</table>
<p class="caption">$WEB_DEL_SEL return codes</p>
 
 
$Web_Del_Sel will delete a global select element, preventing its further use; an example of this is shown in [[$Web_Selp]]. Other than this, $Web_Del_Sel is not needed to perform any processing supplied by the $WEB_SELx functions; unused global select elements will simply have their contents migrate out of the buffer pool and remain as unused CCATEMP pages.


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

Revision as of 22:49, 12 October 2012

<section begin="desc" />Delete a global select element<section end="desc" />

$Web_Del_Sel deletes a global select element, preventing its further use and freeing any CCATEMP pages used by it. An overview of the $Web_Sel* functions is provided in $Web_Selp.

$Web_Del_Sel is a callable $function, and it can be run from a non-Janus Web Server thread.

Syntax

<section begin="syntax" />%rc = $Web_Del_Sel(global_name) <section end="syntax" />

Syntax terms

%rc A numeric return code. 0 is always returned.
global_name The name of the global select element to delete. If it has not been saved by $Web_Save_Sel, this routine does nothing.

Usage notes

  • $Web_Del_Sel will delete a global select element, preventing its further use; an example of this is shown in $Web_Selp. Other than this, $Web_Del_Sel is not needed to perform any processing supplied by the $WEB_SELx functions; unused global select elements will simply have their contents migrate out of the buffer pool and remain as unused CCATEMP pages.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Web_Del_Sel&oldid=35967"