IHeaderCtrl2::GetColumnFilter メソッド (mmc.h)

IHeaderCtrl2::GetColumnFilter メソッドは、指定された列に設定されたフィルター値を取得します。

構文

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

[in] nColumn

フィルター値とその最大文字長を取得する列を識別する 0 から始まるインデックス。

[in, out] pdwType

MMC_FILTER_TYPE列挙で指定されたフィルター値のいずれかを受け取ることができる DWORD 型の変数へのポインター。指定した列のフィルターの種類は、 pdwType が指すアドレスに配置されます。

[in, out] pFilterData

実際のフィルターデータを保持する MMC_FILTERDATA 構造体へのポインター。

このメソッドは、これらの値のいずれかを返すことができます。

設定値と読み取りフィルター値の両方について、スナップインは MMC_FILTERDATA 構造と任意のテキストバッファーを所有します。

フィルター値を読み取るとき、スナップインで指定されたフィルターの種類が現在の型と一致しない場合、 IHeaderCtrl2::GetColumnFilter メソッドは E_FAILを返します。 E_FAILを受信すると、メソッドによって返される値は未定義になります。