Header_ClearFilter

Header_ClearFilter macro

Clears the filter for a given header control. You can use this macro or send the HDM_CLEARFILTER message explicitly.

Syntax


int Header_ClearFilter(
   HWND hwnd,
   int  i
);

Parameters

hwnd

Type: HWND

A handle to the header control.

i

Type: int

A value specifying the column of the filter to be cleared. Specifying -1 will clear all of the filters.

Return value

Returns an integer that indicates TRUE(1) or FALSE(0).

Remarks

If the column value is specified as -1, all the filters will be cleared and the HDN_FILTERCHANGE notification will be sent only once.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Commctrl.h

See also

Header_ClearAllFilters

 

 

Show:
© 2016 Microsoft