$Web Sel Check: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
m (→Example) |
||
(3 intermediate revisions by one other user not shown) | |||
Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%rc</span> = $Web_Sel_Check(global_name, selected_value, option_keywords) | <p class="syntax"><span class="term">%rc</span> = <span class="literal">$Web_Sel_Check</span>(<span class="term">global_name</span>, <span class="term">selected_value</span>, <span class="term">option_keywords</span>) | ||
</p> | </p> | ||
Line 46: | Line 46: | ||
</table> | </table> | ||
== | ==Examples== | ||
<ol> | <ol> | ||
<li>The following statement will cancel the <var class="product">User Language</var> request if the string <code>DAY6</code> is not one of the values of the global select element <code>DAYS.ESPERANTO</code>: | <li>The following statement will cancel the <var class="product">User Language</var> request if the string <code>DAY6</code> is not one of the values of the global select element <code>DAYS.ESPERANTO</code>: |
Latest revision as of 22:35, 12 April 2013
Check string against a global select element
$Web_Sel_Check validates that a string matches one of the options of a global select element. An overview of the $Web_Sel* functions is provided in $Web_Selp.
Syntax
%rc = $Web_Sel_Check(global_name, selected_value, option_keywords)
Syntax terms
%rc | a numeric result code; for some types of errors, the current User Language request is cancelled. | ||||
---|---|---|---|---|---|
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. This is a required argument. | ||||
selected_value | A string which is checked to see if it is equal to one of the values in the options list. This a required argument. | ||||
option_keywords | A string of blank-separated keywords specifying special processing for this $function. Any of the following is valid:
This an optional argument. |
$Web_Sel_Check return codes
Code | Meaning |
---|---|
0 | Selected_value equal to one of the values in global select element global_name. |
1 | Global_name not a saved global select element, and NOCAN option specified. |
2 | Selected_value not equal to any of the values in global select element global_name, and CANCHECK option not specified. |
Any other error results in cancellation of the User Language request. |
Examples
- The following statement will cancel the User Language request if the string
DAY6
is not one of the values of the global select elementDAYS.ESPERANTO
:%rc = $Web_Sel_Check('DAYS.ESPERANTO', 'DN6', 'CANCHECK')
- See $Web_Selp for an extended example using other $WEB_SELx functions.