ListFilter

This function creates a new string list that returns all entries from an string list that match the given filter.

ListFilter( list, filter [, delimiter [, includeEmptyFields [, multiCharacterDelimiter [, parallel [, maxThreads ] ] ] ] ] )

Returns: String

Argument Description Default
list
string, required

list to filter entries from

filter
function, required

function/closure that implements the following constructor [function(any value, numeric index,string list, string delimiter):boolean].

Alias: closure, function

delimiter
string, optional

delimiter used to separate the string list

,

includeEmptyFields
boolean, optional

include empty fields or not

false

multiCharacterDelimiter
boolean, optional

specifying whether the delimiters parameter specifies a multi-character delimiter. If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters. This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.

true

parallel
boolean, optional

execute closures parallel

false

maxThreads
number, optional

maximum number of threads executed, ignored when argument "parallel" is set to false

20

Examples

mylist = "Save|Water|Plant|green";
filterResult = listFilter(mylist,
	function(element, idx){
		if(element != "water" ){
			return true;
		}
		return  false;
	}, "|"
);
writeDump(filterResult);
//Member Function 
listVal="one,two,three,four,five";
res=listVal.listFilter(
	function(elem,ind){
		if(elem!="three"){
			return  true;
		}
		return  false;
	});
writeDump(res);

See also