EditGetLine

Returns the text of the specified line in an Edit control.

Line := EditGetLine(N, Control , WinTitle, WinText, ExcludeTitle, ExcludeText)

Parameters

N

Type: Integer

The line number. Line 1 is the first line.

Control

Type: String, Integer or Object

The control's ClassNN, text or HWND, or an object with a Hwnd property. For details, see The Control Parameter.

WinTitle

Type: String, Integer or Object

A window title or other criteria identifying the target window. See WinTitle.

WinText

Type: String

If present, this parameter must be a substring from a single text element of the target window (as revealed by the included Window Spy utility). Hidden text elements are detected if DetectHiddenText is ON.

ExcludeTitle

Type: String

Windows whose titles include this value will not be considered.

ExcludeText

Type: String

Windows whose text include this value will not be considered.

Return Value

Type: String

This function returns the text of line N in an Edit control. Depending on the nature of the control, the string might end in a carriage return (`r) or a carriage return + linefeed (`r`n).

Error Handling

An exception is thrown if the window or control could not be found, or if N is out of range or otherwise invalid.

Remarks

Window titles and text are case sensitive. Hidden windows are not detected unless DetectHiddenWindows has been turned on.

Related

EditGetCurrentCol, EditGetCurrentLine, EditGetLineCount, EditGetSelectedText, EditPaste, Control functions

Examples

#1: Retrieves the first line of the Notepad's Edit control:

line1 := EditGetLine(1, "Edit1", "ahk_class Notepad")