Returns the number of codeunits 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: 7.0 Security:
# Syntax
codeunitOffset(stringToFind, stringToSearch [, codeunitsToSkip])
# Params
- stringToFind : - stringToSearch : - codeunitsToSkip : The codeunitsToSkip is a non-negative integer. If you don't specify how many codeunitsToSkip, the codeunitOffset function does not skip any codeunits.
# Examples
condeunitOffset(tCodeUnit, "This is the string to search")
# Description
Use the codeunitOffset function to find which sentence a string occurs in.
The value returned by the codeunitOffset function is the number of the codeunit where the stringToFind appears in stringToSearch. If the stringToFind is not in stringToSearch, the codeunitOffset function returns zero. If the stringToFind is more than one codeunit, the codeunitOffset function always returns zero, even if the stringToFind appears in the stringToSearch.
If you specify how manycodeunitsToSkip, the codeunitOffset function skips the specified number of sentences in the stringToSearch. The value returned is relative to this starting point instead of the beginning of the stringToSearch.
# Tags
# See
- **keyword:** codeunit - **function:** wordOffset, paragraphOffset, tokenOffset, sentenceOffset, byteOffset, truewordOffset, codepointOffset, offset - **property:** wholeMatches