$Web Save Sel: Difference between revisions
m (1 revision) |
mNo edit summary |
||
Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Web_Save_Sel}} | {{DISPLAYTITLE:$Web_Save_Sel}} | ||
<span class="pageSubtitle"><section begin="desc" />Save a global select element<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Save a global select element<section end="desc" /></span> | ||
$Web_Save_Sel creates a global select element and saves the list of values (and, optionally, corresponding description strings) in CCATEMP pages. The name of the select element can be used in the $WEB_SEL_x functions to build an HTML <select> element, or to check that a set of values contains only valid selections for the select element. An overview of the $WEB_SEL_x functions is provided in [[$Web_Selp]]. | $Web_Save_Sel creates a global select element and saves the list of values (and, optionally, corresponding description strings) in CCATEMP pages. The name of the select element can be used in the $WEB_SEL_x functions to build an HTML <select> element, or to check that a set of values contains only valid selections for the select element. An overview of the $WEB_SEL_x functions is provided in [[$Web_Selp]]. | ||
Line 12: | Line 10: | ||
<p class="syntax"><section begin="syntax" /> %RC = $Web_Save_Sel( global_name, values, descriptions ) | <p class="syntax"><section begin="syntax" /> %RC = $Web_Save_Sel( global_name, values, descriptions ) | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
Line 21: | Line 17: | ||
<td>The identifier of a $list that contains the select options list values. Each $list item contains one value.</td></tr> | <td>The identifier of a $list that contains the select options list values. Each $list item contains one value.</td></tr> | ||
<tr><th>descriptions</th> | <tr><th>descriptions</th> | ||
<td>The identifier of a $list that contains the select options list descriptions. The descriptions are the strings that are displayed when a browser user clicks on a <select> element. This is an optional argument; if omitted, any select options list generated by the $WEB_SELx functions will have descriptions identical to the option values. The number of items in this $list must be the same as the number of items in the values $list. | <td>The identifier of a $list that contains the select options list descriptions. The descriptions are the strings that are displayed when a browser user clicks on a <select> element. This is an optional argument; if omitted, any select options list generated by the $WEB_SELx functions will have descriptions identical to the option values. The number of items in this $list must be the same as the number of items in the values $list. | ||
</td></tr></table> | </td></tr></table> | ||
Line 35: | Line 27: | ||
<tr><th></th> | <tr><th></th> | ||
<td>Any error results in cancellation of the User Language request.</td></tr> | <td>Any error results in cancellation of the User Language request.</td></tr> | ||
</table> | </table> | ||
<p class="caption">$WEB_SAVE_SEL return codes</p> | <p class="caption">$WEB_SAVE_SEL return codes</p> | ||
See [[$Web_Selp]] for an extended example which includes use of $Web_Save_Sel. | See [[$Web_Selp]] for an extended example which includes use of $Web_Save_Sel. | ||
[[Category:Janus Web Server $functions|$Web_Save_Sel]] | [[Category:Janus Web Server $functions|$Web_Save_Sel]] |
Revision as of 21:33, 22 February 2011
<section begin="desc" />Save a global select element<section end="desc" />
$Web_Save_Sel creates a global select element and saves the list of values (and, optionally, corresponding description strings) in CCATEMP pages. The name of the select element can be used in the $WEB_SEL_x functions to build an HTML <select> element, or to check that a set of values contains only valid selections for the select element. An overview of the $WEB_SEL_x functions is provided in $Web_Selp.
$Web_Save_Sel is a callable $function (see Calling Sirius Mods $functions), and it can be run from a non-Janus Web Server thread.
$Web_Save_Sel takes three arguments and always returns zero, unless an error occurs, in which case the current User Language request is cancelled.
Syntax
<section begin="syntax" /> %RC = $Web_Save_Sel( global_name, values, descriptions ) <section end="syntax" />
global_name | The name of the global select element to create. This name can be used by the $WEB_SELx functions to build a select options list or to check a set of selected values. If a global select element by this name already exists, it is deleted before the new element is created. |
---|---|
values | The identifier of a $list that contains the select options list values. Each $list item contains one value. |
descriptions | The identifier of a $list that contains the select options list descriptions. The descriptions are the strings that are displayed when a browser user clicks on a <select> element. This is an optional argument; if omitted, any select options list generated by the $WEB_SELx functions will have descriptions identical to the option values. The number of items in this $list must be the same as the number of items in the values $list. |
Code | Meaning |
---|---|
0 | The operation completed successfully. |
Any error results in cancellation of the User Language request. |
See $Web_Selp for an extended example which includes use of $Web_Save_Sel.