$Web Del Sel: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Syntax) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Web_Del_Sel}} | {{DISPLAYTITLE:$Web_Del_Sel}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Delete a global select element</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]]. | <var>$Web_Del_Sel</var> 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. | <var>$Web_Del_Sel</var> is a [[Calling_Sirius_Mods_$functions|callable]] $function, and it can be run from a non-<var class="product">Janus Web Server</var> thread. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%rc</span> = <span class="literal">$Web_Del_Sel</span>(<span class="term">global_name</span>) | ||
< | </p> | ||
===Syntax terms=== | ===Syntax terms=== | ||
| Line 14: | Line 14: | ||
<tr><th>%rc</th> | <tr><th>%rc</th> | ||
<td>A numeric status code. 0 is always returned. | <td>A numeric status 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 <var>$Web_Save_Sel</var>, this routine does nothing. | ||
</td></tr></table> | </td></tr></table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<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. | <li>$Web_Del_Sel will delete a global select element, preventing its further use; an example of this is shown in <var>[[$Web_Selp]]</var>. Other than this, <var>$Web_Del_Sel</var> 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. | ||
</ul> | </ul> | ||
[[Category:Janus Web Server $functions|$Web_Del_Sel]] | [[Category:Janus Web Server $functions|$Web_Del_Sel]] | ||
Latest revision as of 22:40, 5 June 2013
Delete a global select element
$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
%rc = $Web_Del_Sel(global_name)
Syntax terms
| %rc | A numeric status 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.