$Web_Selps_Check

From m204wiki
Revision as of 18:18, 10 April 2013 by JALWiccan (talk | contribs) (Automatically generated page update)
Jump to navigation Jump to search

Check parameters against a delimited list of strings

$Web_Selps_Check validates that each value of a form and/or isindex parameter matches one of a delimited list of strings. Note that although this is provided for a sort of symmetry in the $Web_Sel* functions, it is not really restricted to select options list processing. An overview of the $Web_Sel* functions is provided in $Web_Selp.

$Web_Selps_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_Selps_Check(delimited_strings, param_name, [option_keywords])

Syntax terms

delimited_strings A string containing a delimited list of strings which are used to check the values of the parameter. 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. This is a required argument.
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 strings in the delimited list. This a required argument.
option_keywords This optional argument 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
NOFORM Don't look in form parameters
NOISINDEX Don't look in isindex parameters
NOISI Synonym for NOISINDEX

Return codes

global select element global_name. global select element global_name, and CANCHECK option not specified.
Code Meaning
0 Selected_value equal to one of the values in
2 Selected_value not equal to any of the values in
Any other error results in cancellation of the User Language request.

Usage notes

  • See $Web_Selp for an extended example using other $WEB_SELx functions.
  • $Web_Selps_Check and $Web_Selsp_Check are synonyms.

Examples

The following statement will cancel the User Language request if the value of the form parameter DN is not one of the stringsDN0, DN1, etc.:

%rc = $Web_Selsp_Check('/DN0/DN1/DN2' - WITH '/DN3/DN4/DN5/DN6', - 'DN', 'CANCHECK')