This repository was archived by the owner on Aug 31, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 227
Expand file tree
/
Copy pathcodeunitOffset.lcdoc
More file actions
57 lines (38 loc) · 1.66 KB
/
codeunitOffset.lcdoc
File metadata and controls
57 lines (38 loc) · 1.66 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
Name: codeunitOffset
Type: function
Syntax: codeunitOffset(<stringToFind>, <stringToSearch> [, <codeunitsToSkip>])
Summary:
Returns the number of codeunits between the beginning of a value and an
occurrence of a specified string.
Introduced: 7.0
OS: mac, windows, linux, ios, android
Platforms: desktop, server, mobile
Example:
condeunitOffset(tCodeUnit, "This is the string to search")
Parameters:
stringToFind (string):
stringToSearch (string):
codeunitsToSkip:
The codeunitsToSkip is a non-negative integer. If you don't specify how
many codeunitsToSkip, the codeunitOffset function does not skip any
codeunits.
Returns:
The <codeunitOffset> function returns a non-negative integer.
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>.
References: wordOffset (function), paragraphOffset (function),
tokenOffset (function), sentenceOffset (function), byteOffset (function),
truewordOffset (function), codepointOffset (function), offset (function),
codeunit (keyword), wholeMatches (property)
Tags: text processing