$Web Save Sel: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 2: Line 2:
<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* 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*> functions is provided in <var>[[$Web_Selp]]</var>.  
$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* 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* functions is provided in <var>[[$Web_Selp]]</var>.  


$Web_Save_Sel is a callable $function (see [[Calling_Sirius_Mods_$functions|Calling Sirius Mods $functions]]), and it can be run from a non-''[[Janus Web Server]]'' thread.  
$Web_Save_Sel is a [[Calling_Sirius_Mods_$functions|callable]] $function, 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 <var class="product">User Language</var> request is cancelled.
$Web_Save_Sel takes three arguments and always returns zero, unless an error occurs, in which case the current <var class="product">User Language</var> request is cancelled.

Revision as of 18:57, 15 June 2012

<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* 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* functions is provided in $Web_Selp.

$Web_Save_Sel is a callable $function, 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.

$WEB_SAVE_SEL return codes

See $Web_Selp for an extended example which includes use of $Web_Save_Sel.