Plug-in Reference — Structures — FILTER_INFO

# FILTER_INFO

Used by EE_FILTER message. This structure is obsolete. New plug-ins should use the FILTER_INFO_EX structure instead.

    typedef struct _FILTER_INFO {
    	UINT cbSize;
    	UINT flags;
    	int iColumn;
    	LPCWSTR pszFilter;
    	INT_PTR xBegin;
    	INT_PTR xEnd;
    } FILTER_INFO;

## Fields

cbSize

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

flags

Specifies a combination of the following values.

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_ESCAPE | Uses escape sequences.
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_NEGATIVE | Shows the Filter toolbar and excludes the lines that match the specified string.
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.

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.

## Version

Supported on EmEditor Professional Version 14.7 or later.