IsOneOf (String function)

This intrinsic function returns a Boolean value that indicates whether the method object string is matched by one of the strings in an input list of strings. The input list of strings is concatenated in a single delimited longstring argument to the method. A returned value of 'True' signals a successful match.

The IsOneOf function is available as of version 7.3 of the Sirius Mods.

IsOneOf syntax

  %bool = string:IsOneOf(stringSet)                                                                           

Syntax Terms

%bool

An enumeration object of type Boolean to contain the returned value of IsOneOf.

string

The string to which the method is applied, the maximum length of which is 255 bytes.

stringSet

A longstring that contains a delimited set of potential matching strings for the method object string. The strings in stringSet are separated by a separator character, which must be indicated by the first character of the argument. The separator must be non-alphanumeric. The format of stringSet is therefore separatorString1[separatorString2]....

Usage Notes

• The stringSet argument must be non-null or the request is cancelled.

Examples

The following are IsOneOf sample statements:

   %str is longstring                                                                     
   %str = 'bleh'                                                                          
   printText {~} = '{%str:isOneOf('/blah/bleh/blih')}'            
   printText {~} = '{%str:isOneOf(',blah,bleh,blih')}'                                    
   printText {~} = '{%str:isOneOf('/blah/blh/blih')}'                                     
                                                                                          

The results are respectively:

   %str:isOneOf('/blah/bleh/blih') = True                                                 
   %str:isOneOf(',blah,bleh,blih') = True                                                 
   %str:isOneOf('/blah/blh/blih') = False