[%CFEngine_function_prototype(filter, list, is_regex, invert, max_return)%]

Description: Transforms a list or data container into a list subset thereof.

This is a generic filtering function that returns a list of up to max_return elements in list that match the filtering rules specified in filter, is_regex and invert.

[This function can accept many types of data parameters.][Functions#collecting functions]

Arguments:

Treat filter as a regular expression or as a static string.

Invert filter.

Example:

[%CFEngine_include_snippet(filter.cf, #+begin_src cfengine3, .*end_src)%]

Output:

[%CFEngine_include_snippet(filter.cf, #+begin_src\s+example_output\s, .end_src)%]

History: The [collecting function][Functions#collecting functions] behavior was added in 3.9.

See also: [About collecting functions][Functions#collecting functions], grep(), every(), some(), and none().