lineOffset

Typefunction
DictionaryLCS
LibraryLiveCode Script
Syntax
lineOffset(<lineToFind>, <stringToSearch> [, <linesToSkip>])
Summary

Returns the number of lines between the beginning of a value and an occurrence of a specified string.

Introduced1.0
OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Parameters
NameTypeDescription
lineToFind
stringToSearch
linesToSkip

A non-negative integer. If you don't specify how many linesToSkip, the lineOffset function does not skip any lines.

Example
lineOffset("cheese",foodsList)
put subbedData into line (lineOffset(it,receivedData)) of receivedData
Values
NameTypeDescription
return

The lineOffset function returns a non-negative integer.

RelatedKeyword: integer, line, string, lines
Property: wholeMatches
Function: wordOffset, offset, value
Glossary: return, non-negative
Control Structure: function
Description

Use the lineOffset function to find which line a string occurs in.

The value returned by the lineOffset function is the number of the line where lineToFind first appears in stringToSearch. If the lineToFind is not in stringToSearch, the lineOffset function returns zero. If the lineToFind spans more than one line, the lineOffset function always returns zero, even if the lineToFind appears in the stringToSearch.

If you specify how many linesToSkip, the lineOffset function skips the specified number of lines in the stringToSearch. The value returned is relative to this starting point instead of the beginning of the stringToSearch.

Tagstext processing