Show/Hide Toolbars

EmEditor Help

Navigation: EmEditor Help > Plug-in Reference > Messages

EmEditor Plug-in Reference: EE_GET_FILTER

Scroll Prev Top Next More
EmEditor Home - EmEditor Help - Plug-in Reference - Messages

EE_GET_FILTER

Retrieves the filter strings and settings for the current document. You can send this message explicitly or use the Editor_GetFilter inline function.

EE_GET_FILTER

   wParam = (WPARAM) (FILTER_INFO_EX*) pFilterInfo;

   lParam = (LPARAM)(int)iFilter;

Parameters

pFilterInfo

Pointer to the FILTER_INFO_EX structure.

iFilter

Specifies the index of the filter whose string and settings you want to retrieve, or -1 to get the number of filters.

Return Value

The return value is TRUE if the iFilter is 0 or larger and the message was successful. The return value is the number of filters if the iFilter is -1.

Version

Supported on EmEditor Professional Version 16.0 or later.

Copyright © 2003-2016 by Emurasoft, Inc.