Click or drag to resize

ATLine Function

Return the line number of the first occurrence of a substring within a multiple line string.

Namespace:  XSharp.Core
Assembly:  XSharp.Core (in XSharp.Core.dll) Version: 2.6
Syntax
 FUNCTION ATLine(
	cSearch AS STRING,
	cTarget AS STRING
) AS DWORD
Request Example View Source

Parameters

cSearch
Type: String
The substring to search for.
cTarget
Type: String
The string in which to search.

Return Value

Type: UInt32
The position of the first occurrence of <cSearch> within <cTarget>.
If <cSearch> is not found, AtLine() returns 0.
Remarks
If you only need to know whether a substring exists within another string, use the InStr() function or the $ operator.
Examples
These examples show typical use of AtLine():
X#
1LOCAL cBigString AS STRING
2cBigString := "This is the first line" + ;
3    CRLF + "This is the second line" + ;
4    CRLF + "This is the third line"
5? AtLine("third", cBigString)            // 3
See Also