includes

The includes task searches an input variable for a predefined value and returns true if the value is found, or false if it is not.

Potential use case

Use this task if you need to scan an email list for the word “unsubscribe” and execute a process to remove that email address from a database.

Properties

Examples

Example 1

In this example:

• The str variable is statically set to 12 Dollars And 43 Cents.
• The searchString is Cents.
• The position is statically set to 19.
• The result is false — starting at position 19, the str value reads "ents", so no complete match of Cents is found from that position onward.

Example 2

In this example:

• The str variable is statically set to 12 Dollars And 43 Cents.
• The searchString is cents (lowercase).
• The position is statically set to 18.
• The result is false — the task is case sensitive, so "cents" does not match "Cents".

Example 3

In this example:

• The str variable is statically set to 12 Dollars And 43 Cents.
• The searchString is Cents.
• The position is left blank, defaulting to 0.
• The result is true — "Cents" does appear within the str variable.