Show/Hide Toolbars

EmEditor Help

EmEditor Home - EmEditor Help - Plug-in Reference - Inline Functions

Editor_GetLineW

Retrieves the Unicode text on the specified line. You can use this inline function or explicitly send the EE_GET_LINEW message.

Editor_GetLineW( HWND hwnd, GET_LINE_INFO* pGetLineInfo, LPWSTR szString );

Editor_GetLineW( HWND hwnd, HEEDOC hDoc, UINT_PTR yLine, LPWSTR pBuf, UINT_PTR cchBuf, UINT flags, BYTE byteCrLf )

Parameters

hwnd

Specifies the window handle of the view or frame of EmEditor.

pGetLineInfo

Pointer to the GET_LINE_INFO structure.

szString

Pointer to the buffer that will receive the text.

hDoc

Specifies the handle to the target document.

yLine

Specifies a line number of the text to retrieve.

pBuf

Pointer to the buffer that will receive the text.

cchBuf

Specifies the maximum number of characters to copy to the buffer specified by the pBuf parameter. If zero is specified, the return value is the required size, in characters, for the 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.

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 parameter. 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.

Return Values

If cchBuf is zero, the return value is the required size, in characters, for a buffer that can receive the text. If cchBuf is not zero, the return value is not used.

Copyright © 2003-2023 by Emurasoft, Inc.