Plug-in Reference — Structures — FILTER_INFO_EX

# FILTER_INFO_EX

Used by EE_FILTER and EE_GET_FILTER messages.

    typedef struct _FILTER_INFO_EX {
    	UINT cbSize;
    	UINT64 flags;
    	int iColumn;
    	LPWSTR pszFilter;
    	INT_PTR xBegin;
    	INT_PTR xEnd;
    	UINT cchFilter;
    	int nVisibleLinesAbove;
    	int nVisibleLinesBelow;
    } FILTER_INFO_EX;

## Fields

cbSize

Specifies the size of this structure, sizeof( FILTER_INFO_EX ).

flags

Specifies a combination of the following values.

FLAG_FIND_BOOKMARKED_ONLY | Matches bookmarked lines only. This flag cannot be combined with FLAG_FIND_UNBOOKMARKED_ONLY.
FLAG_FIND_CASE | Matches cases.
FLAG_FIND_CONTINUE | Specifies the EE_FILTER message called next time should not clear the filter. This filter is not applied immediately after this message is called. This flag is used when you want to create multiple levels of the filter. It is similar to the FLAG_FIND_KEEP_PREVIOUS flag, but since the actual filter is not applied each time the message is called, this method works faster if there are multiple filter levels.
FLAG_FIND_CR_LF | Matches lines of which the newline character is CR and LF. This flag must be combined with FLAG_FIND_MATCH_NL.
FLAG_FIND_CR_ONLY | Matches lines of which the newline character is CR only. This flag must be combined with FLAG_FIND_MATCH_NL.
FLAG_FIND_ESCAPE | Uses escape sequences.
FLAG_FIND_FUZZY | Uses fuzzy matching.
FLAG_FIND_KEEP_PREVIOUS | Specifies the EE_FILTER message should not clear the existing filter before applying the new filter. This flag is used when you want to create multiple levels of the filter.
FLAG_FIND_LOGICAL_OR | Specifies a logical disjunction (logical OR) to the previous level in case of multiple levels of the filter.
FLAG_FIND_LF_ONLY | Matches lines of which the newline character is LF only. This flag must be combined with FLAG_FIND_MATCH_NL.
FLAG_FIND_LINK_FILE | Specifies pszFilter is the file path to a linked file that contains multiple search strings divided by newlines. If a tab character is included in a line, the search string is the first string not including the tab character. pszFilter may be a relative path from the EmEditor install path. It may contain environment variables such as %USERPROFILE%.
FLAG_FIND_MATCH_NL | Matches specified newline characters. This flag should be combined with FLAG_FIND_CR_LF, FLAG_FIND_CR_ONLY, FLAG_FIND_LF_ONLY, and/or FLAG_FIND_NL_OTHERS.
FLAG_FIND_NEGATIVE | Shows the Filter toolbar and excludes the lines that match the specified string.
FLAG_FIND_NL_OTHERS | Matches lines without a newline character. These lines includes the last line of the file and very long lines that continue to the next line without a newline character. This flag must be combined with FLAG_FIND_MATCH_NL.
FLAG_FIND_NUMBER_RANGE | Matches a number range. This flag cannot be combined with FLAG_FIND_ESCAPE or FLAG_FIND_REG_EXP.
FLAG_FIND_ONLY_WORD | Searches only words.
FLAG_FIND_REG_EXP | Uses a regular expression.
FLAG_FIND_REMOVE_LAST | Removes the last added filter level.
FLAG_FIND_UNBOOKMARKED_ONLY | Matches unbookmarked lines only. This flag cannot be combined with FLAG_FIND_BOOKMARKED_ONLY.
FLAG_FILTER_BEGIN | Specifies a begin filter. This flag cannot be combined with FLAG_FILTER_END.
FLAG_FILTER_END | Specifies an end filter. This flag cannot be combined with FLAG_FILTER_BEGIN.

iColumn

Specifies the index of the column of the text you want to search, or -1 if you want to search whole lines, or -2 if you want to specify the beginning and end of the text in characters as xBegin and xEnd.

pszFilter

Specifies a string to search for.

xBegin

Specifies the index of beginning of the column (in logical characters) of the text you want to search, or -1 if you want to count the last portion of the text and specify as xEnd. The iColumn must be -2 to enable this field.

xEnd

Specifies the index of ending of the column (in logical characters) of the text you want to search, or -1 if you want to search all the rest of the text. The iColumn must be -2 to enable this field.

cchFilter

Specifies the buffer size in characters for the string to retrieve.

nVisibleLinesAbove

Specifies the number of additional lines to display above matched lines. Uses the previously used value if -1 is specified.

nVisibleLinesBelow

Specifies the number of additional lines to display below matched lines. Uses the previously used value if -1 is specified.

## Version

Supported on EmEditor Professional Version 16.0 or later.