$Web Selp Check: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$Web_Selp_Check}}
{{DISPLAYTITLE:$Web_Selp_Check}}
<span class="pageSubtitle"><section begin="desc" />Check parameters against a global select element<section end="desc" /></span>
<span class="pageSubtitle">Check parameters against a global select element</span>


<var>$Web_Selp_Check</var> validates that each value of a form and/or isindex parameter matches one of the options of a global select element. An overview of the <var>$Web_Sel_xxx</var> functions is provided in <var>[[$Web_Selp]]</var>.


<var>$Web_Selp_Check</var> takes three arguments and returns a numeric result code; for some types of errors, the current <var class="product">User Language</var> request is cancelled.


$Web_Selp_Check validates that each value of a form and/or isindex parameter matches one of the options of a global select element. An overview of the $WEB_SEL_x functions is provided in [[$Web_Selp]].
$Web_Selp_Check takes three arguments and returns a numeric result code; for some types of errors, the current <var class="product">User Language</var> request is cancelled.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RC = $Web_Selp_Check(global_name, param_name, -
<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Web_Selp_Check</span>(<span class="term">global_name</span>, <span class="term">param_name</span>, [<span class="term">option_keywords</span>])
option_keywords)
</p>
<section end="syntax" /></p>
 
 


===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>global_name</th>
<tr><th>global_name</th>
<td>The name of the global select element containing the values to check against. The global select element with this name must have been created by <var>$Web_Save_Sel</var>. </td></tr>


<td>The name of the global select element containing the values to check against. The global select element with this name must have been created by $Web_Save_Sel. This is a required argument.</td></tr>
<tr><th>param_name</th>
<tr><th>param_name</th>
<td>The name of a form and/or an index parameter in the current web request. For each occurrence of this parameter, its value is checked to see if it is equal to one of the values in the options list. </td></tr>


<td>The name of a form and/or an index parameter in the current web request. For each occurrence of this parameter, its value is checked to see if it is equal to one of the values in the options list. This a required argument.</td></tr>
<tr><th>option_keywords</th>
<tr><th>option_keywords</th>
 
<td>An optional argument that is a string of blank-separated keywords specifying special processing for this $function; it can contain any of the following:
<table class="syntaxTable">
<table class="syntaxTable">
<td>A string of blank-separated keywords specifying special processing for this $function; it can contain any of the following:</td></tr>
<tr><th>CANCHECK</th>
<tr><th>CANCHECK</th>
<td>Cancel request if any value of ''param_name'' not found in select options list</td></tr>
<td>Cancel request if any value of ''param_name'' not found in select options list</td></tr>
<tr><th>NOCAN</th>
<tr><th>NOCAN</th>
<td>Don't cancel request if ''global_name'' not found</td></tr>
<td>Don't cancel request if ''global_name'' not found</td></tr>
<tr><th>NOFORM</th>
<tr><th>NOFORM</th>
<td>Don't look in form parameters</td></tr>
<td>Don't look in form parameters</td></tr>
<tr><th>NOISINDEX</th>
<tr><th>NOISINDEX</th>
<td>Don't look in isindex parameters</td></tr>
<td>Don't look in isindex parameters</td></tr>
<tr><th>NOISI</th>
<tr><th>NOISI</th>
<td>Synonym for NOISINDEX
<td>Synonym for NOISINDEX
</td></tr></table>
</td></tr></table>
This an optional argument.
</td></tr></table>
</td></tr></table>


===Return codes===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>Code</th>
<tr><th>Code</th>
<td>Meaning</td></tr>
<th>Meaning</th></tr>
<tr><th>0</th>
 
<td>'''All''' values of ''param_name'' equal to some value in</td>
<tr><td>0</td>
global select element ''global_name''.<tr><th>1</th>
<td>'''All''' values of <var class="term">param_name</var> equal to some value in
<td>''Global_name'' not a saved global select element, and NOCAN option</td>
global select element <var class="term">global_name</var>. </td></tr>
specified.<tr><th>2</th>
 
<td>'''Some''' value of ''param_name'' not equal to any value in</td>
<tr><td>1</td>
global select element ''global_name'', and CANCHECK option not specified.<tr><th></th>
<td>''Global_name'' not a saved global select element, and <var>NOCAN</var> option
specified.</td></tr>
 
<tr><td>2</td>
<td>'''Some''' value of <var class="term">param_name</var> not equal to any value in
global select element <var class="term">global_name</var>, and <var>CANCHECK</var> option not specified.</td></tr>
<tr><th></th>
<td>Any other error results in cancellation of the <var class="product">User Language</var> request.</td></tr>
<td>Any other error results in cancellation of the <var class="product">User Language</var> request.</td></tr>
</table>
</table>
<p class="caption">$WEB_SELP_CHECK return codes</p>


See [[$Web_Selp]] for an extended example which includes use of $Web_Selp_Check.
==Examples==
See <var>[[$Web_Selp]]</var> for an extended example which includes use of <var>$Web_Selp_Check</var>.


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

Latest revision as of 17:12, 16 April 2013

Check parameters against a global select element

$Web_Selp_Check validates that each value of a form and/or isindex parameter matches one of the options of a global select element. An overview of the $Web_Sel_xxx functions is provided in $Web_Selp.

$Web_Selp_Check takes three arguments and returns a numeric result code; for some types of errors, the current User Language request is cancelled.

Syntax

%rc = $Web_Selp_Check(global_name, param_name, [option_keywords])

Syntax terms

global_name The name of the global select element containing the values to check against. The global select element with this name must have been created by $Web_Save_Sel.
param_name The name of a form and/or an index parameter in the current web request. For each occurrence of this parameter, its value is checked to see if it is equal to one of the values in the options list.
option_keywords An optional argument that is a string of blank-separated keywords specifying special processing for this $function; it can contain any of the following:
CANCHECK Cancel request if any value of param_name not found in select options list
NOCAN Don't cancel request if global_name not found
NOFORM Don't look in form parameters
NOISINDEX Don't look in isindex parameters
NOISI Synonym for NOISINDEX

Return codes

Code Meaning
0 All values of param_name equal to some value in global select element global_name.
1 Global_name not a saved global select element, and NOCAN option specified.
2 Some value of param_name not equal to any value in global select element global_name, and CANCHECK option not specified.
Any other error results in cancellation of the User Language request.

Examples

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

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Web_Selp_Check&oldid=56063"