$Web Sels Check: Difference between revisions
m (1 revision) |
m (1 revision) |
(No difference)
|
Revision as of 16:00, 15 June 2012
<section begin="desc" />Check string against a delimited list of strings<section end="desc" />
$Web_Sels_Check validates that a string matches one of a delimited list of strings. Note that although this is provided for a sort of symmetry in the $WEB_SELx functions, it is somewhat unnecessary; a simple $ONEOF could do basically the same thing. An overview of the $WEB_SEL_x functions is provided in $Web_Selp.
$Web_Sels_Check takes three arguments and returns a numeric result code; for some types of errors, the current User Language request is cancelled.
Syntax
<section begin="syntax" /> %RC = $Web_Sels_Check(delimited_strings, selected_value, - option_keywords) <section end="syntax" />
delimited_strings | A string containing a delimited list of strings which are used to check the string. The first character of this argument is the delimiter that separates the values. The string should not contain a trailing delimiter unless one of the values is the null string, which is unlikely, at least when used with select option lists. This is a required argument. |
---|---|
selected_value | A string which is checked to see if it is equal to one of the delimited strings. This a required argument. |
option_keywords |
A string of blank-separated keywords specifying special processing for this $function; it can contain any of the following: | |
CANCHECK | Cancel request if selected_value not equal to any of the delimited strings |
---|
This an optional argument.
Code | Meaning |
---|---|
0 | Selected_value equal to one of the delimited strings. |
2 | Selected_value not equal to any of the delimited strings, |
Any other error results in cancellation of the User Language request. |
For example, the following statement will cancel the User Language request if the value of variable %SEL is not one of the stringsDN0, DN1, etc.:
%RC = $Web_Sels_Check('/DN0/DN1/DN2/DN3/DN4' - WITH '/DN5/DN6', %SEL, 'CANCHECK')
See $Web_Selp for an extended example using other $WEB_SELx functions.