itemOffset

returns the number of items between the beginning of a value and an occurrence of a specified string.

# Metadata

Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:

# Syntax

itemOffset(itemToFind, stringToSearch [, itemsToSkip])

# Params

- itemToFind : - stringToSearch : - itemsToSkip : A non-negative integer. If you don't specify how many itemsToSkip, the itemOffset function does not skip any items.

# Examples

itemOffset("C","A,B,C,D,E") -- returns 3

itemOffset("C","A,B,C,D,E",2) -- returns 1

itemOffset("D,E","A,B,C,D,E") -- returns 4

# Description

Use the itemOffset function to find which item a string occurs in.

The value returned by the itemOffset function is the number of the item where itemToFind first appears in stringToSearch. If the itemToFind is not in stringToSearch, the itemOffset function returns zero.

If the itemToFind contains more than one item, and the entire itemToFind appears in the stringToSearch, the itemOffset function returns the item number where the itemToFind starts.

If you specify how many itemsToSkip, the itemOffset function skips the specified number of items in the stringToSearch. The value return is relative to this starting point instead of the beginning of the stringToSearch.

# Tags

text processing,

# See

- **keyword:** item, integer, items, string - **property:** wholeMatches, itemDelimiter - **function:** wordOffset, offset, value - **glossary:** return, non-negative - **control structure:** function