Returns the number of codepoints 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
codepointOffset(stringToFind, stringToSearch [, codepointsToSkip])
# Params
- stringToFind : - stringToSearch : - codepointsToSkip : The codepointsToSkip is a non-negative integer. If you don't specify how many codepointsToSkip, the codepointOffset function does not skip any codepoints.
# Examples
codepointOffset(tCodePoint,"This is the string to search")
# Description
Use the codepointOffset function to find which codepoint a string occurs in.
The value returned by the codepointOffset function is the number of the codepoint where the stringToFind appears in stringToSearch. If the stringToFind is not in stringToSearch, the codepointOffset function returns zero. If the stringToFind is more than one codepoint, the codepointOffset function always returns zero, even if the stringToFind appears in the stringToSearch.
If you specify how many codepointsToSkip, the codepointOffset 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:** codepoint - **function:** wordOffset, paragraphOffset, tokenOffset, sentenceOffset, byteOffset, truewordOffset, codeunitOffset, offset - **property:** wholeMatches