Plug-in Reference — Structures — GET_LINE_INFO

# GET_LINE_INFO

Used by Editor_GetLineA and Editor_GetLineW inline functions ( EE_GET_LINEA and EE_GET_LINEW messages).

    typedef struct _GET_LINE_INFO {
    	UINT cch;
    	UINT flags;
    	UINT yLine;
    	BYTE byteCrLf;
    	HEEDOC hDoc;
    } GET_LINE_INFO;

## Fields

cch

Specifies the maximum number of characters to copy to the buffer (szString parameter of Editor_GetLine macro or lParam of EE_GET_LINE message including the NULL character). If zero is specified, the return value by Editor_GetLine macro or EE_GET_LINE message is the required size, in characters, for a buffer that can receive the text.

flags

The low word of this parameter is a combination of the following values.

FLAG_LOGICAL | Specifies yLine field by logical coordinates yLine.
FLAG_WITH_CRLF | Adds return codes to the text.
FLAG_GET_CRLF_BYTE | Instructs the byteCrLf field to be filled with the flag indicating the newline characters. FLAG_LOGICAL must also be specified.

The high word of this parameter is the index of the target document. A one-based index should be specified at the higher word of flags. If 0 is specified at the higher word of flags, the currently active document will be targeted. If USE_HDOC is specified at the higher word of flags, the hDoc field specifies the handle to the target document.

yLine

Specifies a line number of the text to retrieve.

byteCrLf

Receives the flag indicating the newline characters of the specified line. This field is used only when both FLAG_LOGICAL and FLAG_GET_CRLF_BYTE are specified in the flags field. It will become one of the following values.

0 | CR+LF or the end of file.
FLAG_CR_ONLY | CR only.
FLAG_LF_ONLY | LF only.

hDoc

Specifies the handle to the target document. This field is used only if USE_HDOC is specified at the higher word of the flags field.