Plug-in Reference — Messages — EE_INFO

# EE_INFO

Retrieves or sets the value of one of the information parameters used by EmEditor. You can send this message explicitly or use the Editor_Info, Editor_DocInfo, or Editor_DocInfoEx inline functions.

    EE_INFO
    wParam = (WPARAM)(int)nCmd;
    lParam = (LPARAM)lParam;

Or

    EE_INFO
    wParam = MAKEWPARAM(nCmd, iDoc+1);
    lParam = (LPARAM)lParam;

## Parameters

nCmd

Specifies a parameter to retrieve or set. This parameter can be one of the values from the following table.

nCmd | Meaning | lParam | Return Value
--- | --- | --- | ---
EI_GET_ENCODE | Retrieves the encoding method to save files. | Not used. | (int)nCP The encoding method.
EI_SET_ENCODE | Sets an encoding method to save files. | (UINT)nCP Specifies an encoding method, whose value begins by CODEPAGE_. | Not used.
EI_GET_SIGNATURE | Retrieves whether to sign Unicode/UTF-8 files. | Not used. | (BOOL)bSignature TRUE to sign.
EI_SET_SIGNATURE | Sets whether to sign Unicode/UTF-8 files. | (BOOL)bSignature TRUE to sign. | Not used.
EI_GET_FONT_CHARSET | Retrieves the character set to display. | Not used. | (int)nCharset The character set.
EI_SET_FONT_CHARSET | Sets a character set to display. | (int)nCharset Specifies an character set whose value begins by CHARSET_. | Not used.
EI_GET_FONT_CP | Retrieves the code page used by the font to display. | Not used. | (UINT)nCP The code page.
EI_GET_INPUT_CP | Retrieves the code page used by the input languages. | Not used. | (UINT)nCP The code page.
EI_GET_SHOW_TAG | Retrieves whether to show the tag highlighted. | Not used. | (BOOL)bShowTag TRUE to highlight the tag.
EI_SET_SHOW_TAG | Sets whether to show the tag highlighted. | (BOOL)bShowTag TRUE to highlight the tag. | Not used.
EI_GET_FILE_NAMEA | Retrieves the file name currently opened, in bytes. | (LPSTR)szFileName Specifies a pointer to a buffer to retrieve the file name. The buffer must be MAX_PATH character long including the terminating NULL character. | Not used.
EI_GET_FILE_NAME_EX | Retrieves the file name currently opened, in Unicode. | (STRING_BUF*)pStringBuf Specifies a pointer to a STRING_BUF structure that retrieves the file name. | Not used.
EI_GET_FILE_NAMEW | Retrieves the file name currently opened, in Unicode. | (LPSTR)szFileName Specifies a pointer to a buffer to retrieve the file name. The buffer must be MAX_PATH character long including the terminating NULL character. | Not used.
EI_SET_FILE_NAMEW | Renames the file name currently opened. If the document is untitled, renames the document title without saving the file. | (LPCWSTR)pszName Specifies a new name. | (HRESULT)hr Returns a negative value if failed.
EI_IS_PROPORTIONAL_FONT | Retrieves whether the display font is proportional. | Not Used. | (BOOL)bProportionalFont
EI_GET_NEXT_BOOKMARK | Finds the next book mark position. | (int)yLine Specifies an initial logical line to search from. -1 will search from the beginning of the document. | (int)yLine Returns the searched logical line. -1 will be returned if not found.
EI_GET_HILITE_FIND | Retrieves whether searched strings are highlighted. | Not used. | (BOOL)bShowFindHilite
EI_SET_HILITE_FIND | Sets whether searched strings are highlighted. | (BOOL)bShowFindHilite | Not used.
EI_GET_APP_VERSIONA | Retrieves the version name as an ANSI string. | (LPSTR)szVersionName Specifies a pointer to a buffer to retrieve the version string. The buffer must be MAX_PATH character long including the terminating NULL character. | Not used.
EI_GET_APP_VERSIONW | Retrieves the version name as a Unicode string. | (LPWSTR)szVersionName Specifies a pointer to a buffer to retrieve the version string. The buffer must be MAX_PATH character long including the terminating NULL character. | Not used.
EI_GET_READ_ONLY | Retrieves whether the document is read-only. | Not used. | (BOOL)bReadOnly
EI_IS_WINDOW_COMBINED | Retrieves whether the windows are combined. | Not used. | (BOOL)bCombined
EI_WINDOW_COMBINE | Sets whether the windows are combined. | (BOOL)bCombined Combines the windows if TRUE, or separate the windows if FALSE. | Not used.
EI_IS_UNDO_COMBINED | Retrieves whether an inserted string can be undone at once. | Not used. | (BOOL)bCombined
EI_GET_DOC_COUNT | Retrieves the number of opened documents in the current frame window (EmEditor Professional 5.00 or later only). | Not used. | (int)nCount Returns the number of documents.
EI_INDEX_TO_DOC | Converts a document index to a document handle (EmEditor Professional 5.00 or later only). | Specifies the zero-based index of the document. | (HEEDOC)hDoc Returns the handle to the document.
EI_DOC_TO_INDEX | Converts a document handle to a document index. | Specifies the handle to the document. | (int)nIndex Returns the zero-based index of the document.
EI_ZORDER_TO_DOC | Converts a document z-order to a document handle. | Specifies the zero-based z-order of the document. | (HEEDOC)hDoc Returns the handle to the document.
EI_DOC_TO_ZORDER | Converts a document handle to a document z-order. | Specifies the handle to the document. | (int)nZOrder Returns the zero-based z-order of the document.
EI_GET_ACTIVE_INDEX | Retrieves the index of the active document. | Not used. | (int)nIndex Returns the zero-based index of the document.
EI_SET_ACTIVE_INDEX | Activates a document. | Not used. | (BOOL)bSuccess Returns TRUE if succeeded, or FALSE if failed.
EI_GET_FULL_TITLEA | Retrieves the full title of the document in ANSI string. | (LPSTR)szTitle Specifies the buffer to retrieve the string. The buffer must be MAX_PATH character long including the terminating NULL character. | Not used.
EI_GET_FULL_TITLEW | Retrieves the full title of the document in Unicode string. | (LPWSTR)szTitle Specifies the buffer to retrieve the string. The buffer must be MAX_PATH character long including the terminating NULL character. | Not used.
EI_GET_SHORT_TITLEA | Retrieves the short title of the document in ANSI string. | (LPSTR)szTitle Specifies the buffer to retrieve the string. The buffer must be MAX_PATH character long including the terminating NULL character. | Not used.
EI_GET_SHORT_TITLEW | Retrieves the short title of the document in Unicode string. | (LPWSTR)szTitle Specifies the buffer to retrieve the string. The buffer must be MAX_PATH character long including the terminating NULL character. | Not used.
EI_GET_SAVE_AS_TITLEA | Retrieves the full title of the document except the asterisk (*) indicating modification in ANSI string. | (LPSTR)szTitle Specifies the buffer to retrieve the string. The buffer must be MAX_PATH character long including the terminating NULL character. | Not used.
EI_GET_SAVE_AS_TITLEW | Retrieves the full title of the document except the asterisk (*) indicating modification in Unicode string. | (LPWSTR)szTitle Specifies the buffer to retrieve the string. The buffer must be MAX_PATH character long including the terminating NULL character. | Not used.
EI_MOVE_ORDER | Moves the document tab order. | Specifies the zero-based index of the destination tab. | Not used.
EI_CLOSE_DOC | Closes the document. | Not used. | (BOOL)bSuccess Returns TRUE if succeeded, or FALSE if failed.
EI_SAVE_DOC | Saves the document. If the document is untitled, the Save As dialog box will appear. | Not used. | (BOOL)bSuccess Returns TRUE if succeeded, or FALSE if failed. Selecting Cancel in the Save As dialog box when the document is untitled will also return FALSE.
EI_GET_CURRENT_FOLDER | Retrieves the current working folder. | (LPWSTR)szDir Specifies the buffer to retrieve the string. The buffer must be MAX_PATH character long including the terminating NULL character. | Not used.
EI_IS_LARGE_DOC | Retrieves the flag to indicate whether the document is very large. | Not used. | (BOOL)bLarge Returns TRUE if the document is very large. Otherwise, it returns FALSE.
EI_USE_INI | Retrieves whether the INI files are used instead of the Registry. | Not used. | (BOOL)bIni Returns TRUE if the INI files are used, or FALSE if the Registry is used.
EI_GET_LANGUAGE | Retrieves the currently selected language for the user interface. | (LPWSTR)szFolder Specifies the buffer to retrieve the language folder. The buffer must be MAX_PATH character long including the terminating NULL character. | (UINT)nLangID Returns the currently selected language ID.
EI_COMBINE_HISTORY | Specifies whether to combine the next change with the previous change as one history for Undo. | (BOOL)bCombine TRUE to combine. | Not used.
EI_GET_BAR_TEXT_COLOR | Retrieves the text color of custom bars. | Not used. | (COLORREF)clrText Returns the RGB value of the text color.
EI_GET_BAR_BACK_COLOR | Retrieves the background color of custom bars. | Not used. | (COLORREF)clrBack Returns the RGB value of the background color.
EI_GET_RETURN_TYPE | Retrieves the return type of the current line. If the current line is the last line of the document and does not have a return, it retrieves the return type of the previous line. | (UINT_PTR)yLogicalLine Specifies the index of the logical line. | (int)nReturnType Returns either RETURN_METHOD_BOTH, RETURN_METHOD_CR_ONLY, or RETURN_METHOD_LF_ONLY
EI_GET_ACTIVE_DOC | Retrieves the handle to the active document. | Not used. | (HEEDOC)hDoc Returns the handle to the document.
EI_SET_ACTIVE_DOC | Activates a document. | (HEEDOC)hDoc Specifies the handle to the document to be activated. | (BOOL)bSuccess Returns TRUE if succeeded, or FALSE if failed.
EI_GET_SYNC_SESSION | Retrieves the session ID of the document if the document is in comparison or synchronous scroll mode. | Not used. | (int)nSessionID Returns the session ID if the document is in comparison or synchronous scroll mode. Returns 0 if the document is in normal mode.
EI_GET_LOC_DLL_INSTANCE | Retrieves the handle to the localized resource DLL instance. | Not used. | (HINSTANCE)hinstLoc Returns the handle to the localized resource DLL instance.
EI_GET_RES_DLL_INSTANCE | Retrieves the handle to the resource DLL instance. | Not used. | (HINSTANCE)hinstRes Returns the handle to the resource DLL instance.
EI_GET_CMD_LIST_SIZE | Retrieves the number of items available for the specified multiple-menu command | The first item of the multiple-menu command ID. | (int)nCount Returns the number of items available.
EI_GET_DISCARD_UNDO | Retrieves the flag to indicate whether EmEditor discards undo information to improve the speed of replace, insert or delete. | Not used. | (BOOL)bDiscardUndo Returns the flag.
EI_SET_DISCARD_UNDO | Sets the flag to indicate whether EmEditor discards undo information to improve the speed of replace, insert or delete. | (BOOL)bDiscardUndo The flag. | Not used.
EI_GET_HEADING_LINES | Retrieves the number of lines of the headings (non-scroll area). | Not used. | (int)nHeadingLines
EI_SET_HEADING_LINES | Sets the number of lines of the headings (non-scroll area). | (int)nHeadingLines | Not used.
EI_GET_NARROWING_TOP | Retrieves the top line (y-coordinate) of the narrowing. -1 means the narrowing is not set. | Not used. | (int)nNarrowingTop
EI_SET_NARROWING_TOP | Sets the top line (y-coordinate) of the narrowing. -1 means the narrowing is not set. | (int)nNarrowingTop | Not used.
EI_GET_NARROWING_BOTTOM | Retrieves the bottom line (y-coordinate) of the narrowing. -1 means the narrowing is not set. | Not used. | (int)nNarrowingBottom
EI_SET_NARROWING_BOTTOM | Sets the bottom line (y-coordinate) of the narrowing. -1 means the narrowing is not set. | (int)nNarrowingBottom | Not used.
EI_SET_HILITE_FILTER | Sets the filter using last used find information. Only the active document is allowed. | Not used. | Not used.
EI_GET_CSV | Retrieves the index of the current CSV mode, or -1 if it is not a CSV mode. | Not used. | (int)iCSV
EI_GET_PRINT_PAGES | Retrieves the number of pages for the currently selected printer. Only the active document is allowed. | (BOOL)bSelOnly Specifies whether only the selection is calculated to retrieve the number of pages. | (int)nPages.
EI_GET_COMBINE_HISTORY | Retrieves the flag that shows whether to combine the next change with the previous change as one history for Undo. | Not used. | (BOOL)bCombine
EI_GET_CELL_MODE | Retrieves the flag that shows whether the selection mode is cell selection mode. | Not used. | (BOOL)bCellMode
EI_SET_CELL_MODE | Sets the flag that shows whether the selection mode is cell selection mode. | (BOOL)bCellMode | Not used.
EI_GET_UNTITLED | Retrieves the flag that shows whether the document is untitled. | Not used. | (BOOL)bUntitled
EI_GET_DPI | Retrieves the DPI value at the current monitor. | Not used. | (long)nDPI
EI_GET_FILTER_VISIBLE_LINES_ABOVE | Retrieves the number of visible lines above the matched lines by filters. | Not used. | (long)nLines
EI_SET_FILTER_VISIBLE_LINES_ABOVE | Sets the number of visible lines above the matched lines by filters. | (long)nLines | Not used.
EI_GET_FILTER_VISIBLE_LINES_BELOW | Retrieves the number of visible lines below the matched lines by filters. | Not used. | (long)nLines
EI_SET_FILTER_VISIBLE_LINES_BELOW | Sets the number of visible lines below the matched lines by filters. | (long)nLines | Not used.
EI_GET_DPI_OPTIONS | Retrieves the options related to the monitor. Currently, only DPI_OPTIONS_RESIZE_WHEN_DPI_CHANGED is supported. When DPI_OPTIONS_RESIZE_WHEN_DPI_CHANGED is set, EmEditor resizes the window when the DPI is changed. | Not used. | (long)nFlags
EI_SET_DPI_OPTIONS | Sets the options related to the monitor. Currently, only DPI_OPTIONS_RESIZE_WHEN_DPI_CHANGED is supported. When DPI_OPTIONS_RESIZE_WHEN_DPI_CHANGED is set, EmEditor resizes the window when the DPI is changed. | (long)nFlags | Not used.
EI_GET_REGISTERED_NAME | Retrieves the registered name, which is displayed in the About dialog box. If the product is not registered, an empty string will be retrieved. | (LPWSTR)szName Specifies the buffer to retrieve the string. The buffer must be MAX_REG_NAME character long including the terminating NULL character. | Not used.
EI_VALIDATE_CSV | Validates the CSV document and output errors, and optionally adjusts separator positions. | (int)nFlags You may specify a combination of VALIDATE_ADJUST_COLUMNS, VALIDATE_QUIET, VALIDATE_ADJUST_VISIBLE_ONLY, VALIDATE_DETECT_NL, VALIDATE_QUIET_IF_NO_ERROR, VALIDATE_ADJUST_ENLARGE_ONLY, VALIDATE_DETECT_CSV, and VALIDATE_ASYNC. | (int)nResults Return values are combination of CSV_ADJUSTED, CSV_NL_EMBEDDED, CSV_ABORT, CSV_INVALID_QUOTES, CSV_INCONSISTENT_COLUMNS, CSV_NOT_CSV, CSV_ASYNC_SUCCESS, and CSV_ASYNC_RUNNING. The return value of 0 means there were no errors.
EI_GET_CLIENT_RECT_NO_BARS | Retrieves the coordinates of the editor view excluding the area occupied by scroll bars and the Minimap. | (RECT*)pRect | Returns TRUE if succeeded, or FALSE if failed.
EI_REFRESH_COMMON_SETTINGS | Loads common settings and refreshes the EmEditor window. | Not used. | Not used.
EI_GET_NEWLINE_CODE | Retrieves the newline character code used in the document. | Not used. | Returns FLAG_CR_AND_LF, FLAG_CR_ONLY, FLAG_LF_ONLY, or FLAG_NEWLINE_MIXED.
EI_GET_MEMORY_SIZE | Retrieves the memory size used in the document. The default value can be specified in the Memory Size text box in the Advanced page of the Customize dialog box. | Not used. | Returns the memory size.
EI_SET_MEMORY_SIZE | Sets the memory size used in the document. The default value can be specified in the Memory Size text box in the Advanced page of the Customize dialog box. | (long)nBits Specifies the required memory size. | Returns the new memory size. This value may become greater than the specified size if the document already uses greater memory size than the specified size.
EI_GET_BOOKMARK_COUNT | Retrieves the number of bookmarks in the document. | Not used. | Returns the number of bookmarks in the document.
EI_SYNC_NOW | Triggers EmEditor to sync now. | (UINT)nFlags You may specify a combination of SYNC_FLAG_SEND, SYNC_FLAG_RECEIVE, SYNC_FLAG_FORCE, and SYNC_FLAG_REFRESH_UI. | Not used.
EI_GET_CHAR_TYPE | Retrieves the type of the character. | (LPCWSTR)pch | Returns the type of the character. It can be one of the following types: CHAR_NULL, CHAR_SPACE, CHAR_MARK, CHAR_ALPHANUMERIC, CHAR_KANA , CHAR_KANA_MARK , CHAR_DB_SPACE, CHAR_DB_MARK, CHAR_DB_ALPHANUMERIC, CHAR_DB_HIRA, CHAR_DB_KATA, CHAR_DB_KANJI, CHAR_DB_KANA_MARK, CHAR_SECOND_DB, CHAR_HANGUL, CHAR_DB_HANGUL.
EI_FILE_POS_TO_LOGICAL | Converts a file position to the logical position. | (FILE_POS_INFO*)pFilePosInfo | Not used.
EI_LOGICAL_TO_FILE_POS | Converts a logical position to the file position. | (FILE_POS_INFO*)pFilePosInfo | Not used.
EI_CELL_TO_LOGICAL | Converts a cell position to the logical position. | (CELL_LOGICAL_INFO*)pCellLogicalInfo | Not used.
EI_LOGICAL_TO_CELL | Converts a logical position to the cell position. | (CELL_LOGICAL_INFO*)pCellLogicalInfo | Not used.
EI_IS_VERY_DARK | Checks if the dark mode is supported in the system, and whether the user selects the very dark mode if supported. | Not used. | Returns TRUE if the user selects the very dark mode, FALSE if not, or NOT_SUPPORTED if the dark mode is not supported in the system.
EI_WM_INITDIALOG | Called inside the WM_INITDIALOG message in a dialog procedure to support the very dark mode. | (HWND)hWnd | Not used.
EI_WM_CTLCOLOR | Called inside the WM_CTLCOLORDLG, WM_CTLCOLORSTATIC, WM_CTLCOLOREDIT, WM_CTLCOLORBTN, and WM_CTLCOLORLISTBOX messages in a dialog procedure to support the very dark mode. | (WPARAM)wParam You may forward pass of the WM_CTLCOLORxxx messages. | Returns a brush if the very dark mode is selected. You must pass this value to the dialog procedure return value.
EI_WM_THEMECHANGED | Called inside the WM_THEMECHANGED message in a dialog procedure to support the very dark mode. | (HWND)hWnd | Not used.
EI_INIT_LISTVIEW | Initialize a listview control to support the very dark mode. | (HWND)hWnd | Not used.
EI_GET_VIEW_FONT | Retrieves the handle to the currently selected editor font. | Not used. | (HFONT)hFont
EI_GET_HIDE_QUOTES | Retrieves a flag indicating whether the Unquoted/Unescaped View is enabled in the CSV cell selection mode. | Not used. | (BOOL)bHideQuotes
EI_SET_HIDE_QUOTES | Sets a flag indicating whether the Unquoted/Unescaped View is enabled in the CSV cell selection mode. | (BOOL)bHideQuotes | Not used.
EI_ENABLE_WM_CHAR | Used internally. | Not used. | Used internally.
EI_GET_SYNC | Retrieves the path to the sync folder. | (LPWSTR)szDir Specifies the buffer to retrieve the string. The buffer must be MAX_PATH character long including the terminating NULL character. | Returns a combination of values including SYNC_SETTINGS_SEND and SYNC_SETTINGS_RECEIVE.
EI_GET_SPLIT | Retrieves the split status. | Not used. | Returns one of following values: SPLIT_NONE, SPLIT_HORZ, SPLIT_VERT, SPLIT_BOTH, SPLIT_2_HORZ, or SPLIT_2_VERT
EI_GET_SUM | Retrieves the sum and count of numbers contained in the selection. | (SUM_INFO*)pSumInfo | Returns TRUE if succeeded, or FALSE if failed.
EI_GET_CONFIG | Retrieves the selected configuration name. | Specifies a pointer to a buffer to retrieve the configuration name. The buffer must be MAX_CONFIG_NAME character long including the terminating NULL character. | Not used.
EI_SET_CONFIG | Changes to a specified configuration. | Specifies a configuration name. | (BOOL)bSuccess
EI_SAVE_FILE | Saves a document. | Specifies a full path file name. | (BOOL)bSuccess
EI_INDEX_TO_DOC_REAL | Converts a document index to a document handle. Unlike EI_INDEX_TO_DOC, this command counts unique individual documents in a split window. | Specifies the zero-based index of the document. | (HEEDOC)hDoc Returns the handle to the document.
EI_DOC_TO_INDEX_REAL | Converts a document handle to a document index. Unlike EI_INDEX_TO_DOC, this command counts unique individual documents in a split window. | Specifies the handle to the document. | (int)nIndex Returns the zero-based index of the document.
EI_GET_TITLE | Retrieves the title of the current document. | (STRING_BUF*)pStringBuf Specifies a pointer to a STRING_BUF structure that retrieves the title. | Not used.
EI_SET_TITLE | Sets the title of the current document. The title may contain long and short titles separated by a linefeed (\n). | (LPCWSTR)pszTitle Specifies a new title. | (HRESULT)hr Returns a negative value if failed.
EI_SET_WEB | Sets the flags of the Web Browser. | (UINT)nFlags Specifies a new flag. | Not used.
EI_OPEN_WEB | Opens a website of the specified URL. | (LPCWSTR)pszURL Specifies an URL. | (HRESULT)hWnd Returns the window handle to the web view.
EI_GET_MARKDOWN_PREVIEW | Retrieves whether the Markdown Design View is set. | Not used. | (BOOL)bMarkdownPreview Markdown Design View if TRUE
EI_SET_MARKDOWN_PREVIEW | Toggles the Markdown Design View | (BOOL)bMarkdownPreview Markdown Design View if TRUE | Not used.
EI_IS_CHATAI_INSTALLED | Retrieves whether the ChatAI plug-in is installed. | Not used. | (BOOL)bInstalled Markdown Design View if TRUE
EI_RESET_BOOKMARK | Resets a specified bookmark in a document or all bookmarks in all open documents. | (INT_PTR)y Specifies the line number to reset a bookmark, or all bookmarks in all open documents if -1. | Not used.
EI_BRING_CUSTOM_BAR_TOP | Brings the specified custom bar to the top. | (HWND)hwndClient Specifies the client window | (int)iCustomBar Specifies the custom bar position if found, or -1 if the custom bar is not found.

iDoc

Specifies the index of the target document. A one-based index should be specified at the higher word of wParam. If 0 is specified at the higher word of wParam, the currently active document will be targeted. This parameter may not be used depending on nCmd. In this case, the higher word of wParam must be 0.

lParam

Depends on the parameter specified.

## Return Values

Depends on the parameter specified.

## Version

Supported in EmEditor Professional Version 3.00 or later. However, the iDoc parameter is only supported on Version 5.00 or later.