Plug-in Reference — Messages — EE_FILTER

# EE_FILTER

Filters the document with the specified string and settings. You can send this message explicitly or use the Editor_Filter inline function.

    EE_FILTER
    wParam = (WPARAM) (FILTER_INFO_EX*) pFilterInfo;
    lParam = 0;

## Parameters

pFilterInfo

Pointer to the FILTER_INFO_EX structure.

## Return Value

The return value is the number of the lines that match the specified string. If the specified string is an empty string, and neither FLAG_FIND_BOOKMARKED_ONLY, FLAG_FIND_UNBOOKMARKED_ONLY, nor FLAG_FIND_MATCH_NL is specified, the return value is -1. If FLAG_FIND_CONTINUE is specified, the return value is 0.

## Version

Supported on EmEditor Professional Version 14.7 or later.