InList function [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== InList function  ======


 
==== Description ====
 
Determines whether a specified value exists in a delimited list.
 
==== Syntax ====
 
//truefalse// = **InList**(//list//, //value//, //delimiter//)
 
==== Parameters ====
 
The InList function has the following parameters.

^Parameter^Description^
|//List//|Any array, where the delimiter can be any ANSI value.|
|//Value//|Specify the value to be checked for inclusion in //list//.|
|//Delimiter//|Any ANSI value.|

While the value of //list// can be any string of values delimited by any single ANSI value, there is a convention in BASIC+ that allows certain stored procedures to accept a list as an argument for a parameter. When that condition applies (the parameter name usually has "list" in it), the calling convention is an @FM-delimited string. To determine inclusion in the passed list, you must specify @FM as the delimiter. Only one value can be checked, for each call to InList. Returns either true (1) or false (0).

 
==== See Also ====
 
[[locate|Locate]], [[locate_by|Locate...By]]
 
==== Example ====
 
<code>
/* The value of result is 1, because "BILL" is an item in list. */

List = "BILL":@FM:"MARY":@FM:"JIM"
result = Inlist(list, "BILL", @FM)
</code>