Edit_GetFileLineIndex macro (commctrl.h)

Article
02/22/2024

Gets the index of the file (or logical) line of text based on the specified visible line. You can use this macro or send the EM_FILELINEINDEX message explicitly.

Syntax

void Edit_GetFileLineIndex(
   hwndCtl,
   lineNumber
);

Parameters

hwndCtl

A handle to the edit control.

lineNumber

The file line number, where the number of the first line is 0. If lineNumber = -1, the file line with the caret is used.

Return value

None

Remarks

The logical line index is a zero-based index from the beginning of the edit control.

This macro and corresponding message do not recognize text wrapping (visible lines) and, instead, recognize file (logical) lines with an end-of-line delimiter. When text wrap is turned off, visible lines are equivalent to file lines.

The EM_LINEFROMCHAR, EM_LINEINDEX, EM_LINELENGTH, EM_GETLINE, and EM_GETLINECOUNT messages recognize visible line text wrapping and provide information for the line of text up to the wrapping line break. (Each subsequent line is delimited by the next text wrap break.)

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1809 [desktop apps only]
Minimum supported server	Windows Server [desktop apps only]
Target Platform	Windows
Header	commctrl.h

Share via