Share via


CHeaderCtrl::EditFilter

Begins to edit the specified filter of a header control.

BOOL EditFilter(
   int nColumn,
   BOOL bDiscardChanges
);

Parameters

  • nColumn
    The column to edit.

  • bDiscardChanges
    A value that specifies how to handle the user's editing changes if the user is in the process of editing the filter when the HDM_EDITFILTER message is sent.

    Specify true to discard the changes made by the user, or false to accept the changes made by the user.

Return Value

true if this method is successful; otherwise, false.

Remarks

This method implements the behavior of the Win32 message HDM_EDITFILTER, as described in the Windows SDK.

Example

int iFilter = m_myHeaderCtrl.EditFilter(1, TRUE);

Requirements

Header: afxcmn.h

See Also

Reference

CHeaderCtrl Class

Hierarchy Chart

CHeaderCtrl::ClearAllFilters

CHeaderCtrl::ClearFilter

CHeaderCtrl::SetFilterChangeTimeout

Other Resources

CHeaderCtrl Members