Edit

IHeaderCtrl2::GetColumnFilter method (mmc.h)

  • Article

The IHeaderCtrl2::GetColumnFilter method retrieves the filter value set on the specified column.

Syntax

HRESULT GetColumnFilter(
  [in]      UINT           nColumn,
  [in, out] LPDWORD        pdwType,
  [in, out] MMC_FILTERDATA *pFilterData
);

Parameters

[in] nColumn

A zero-based index that identifies the column for which the filter value and its maximum character length are to be retrieved.

[in, out] pdwType

A pointer to a variable of type DWORD that can take one of the possible filter values specified in the MMC_FILTER_TYPE enumeration. The filter type for the specified column is placed in the address pointed to by pdwType.

[in, out] pFilterData

A pointer to an MMC_FILTERDATA structure that holds the actual filter data.

Return value

This method can return one of these values.

Remarks

For both setting and reading filter values, the snap-in owns the MMC_FILTERDATA structure and any text buffer.

When reading a filter value, if the filter type specified by the snap-in does not match the current type, the IHeaderCtrl2::GetColumnFilter method will return E_FAIL. On receiving an E_FAIL, the values returned by the method are undefined.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header mmc.h
DLL Mmcndmgr.dll

See also

IHeaderCtrl2