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

Editor_DocInfo

Retrieves or sets the value of one of the information parameters used by EmEditor. You can use this inline function or explicitly send the EE_INFO message.

Editor_DocInfo( HWND hwnd, int iDoc, int nCmd, LPARAM lParam );

Parameters

nCmd

Specifies a parameter to retrieve or set. It will be one of the followings. 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_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_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.

iDoc

Specifies the zero-based index of the target document. If -1 is specified, the currently active document will be targeted.

lParam

Depends on the parameter specified.

Return Values

Depends on the parameter specified.

Version

Supported on EmEditor Professional Version 5.00 or later.

Copyright 2003-2014 by Emurasoft, Inc.