Win32 API 日本語リファレンス
ホーム › System.Mmc › IHeaderCtrl2

IHeaderCtrl2

COM
📘 Microsoft Learn (日本語) · English
IID9757abb8-1b32-11d1-a7ce-00c04fd8d565継承元IHeaderCtrl自前メソッド開始 vtbl9

公式ドキュメント

IHeaderCtrl2 インターフェイスは MMC 1.2 で導入されました。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 9 HRESULT SetChangeTimeOut(DWORD uTimeout)

IHeaderCtrl2::SetChangeTimeOut は、フィルター属性に変更が発生してから、スナップインの IComponent::Notify メソッドに送信される MMCN_FILTER_CHANGE フィルター変更通知が投稿されるまでのタイムアウト間隔を設定します。

uTimeoutDWORDinフィルター変更間隔(ミリ秒単位)。既定値はヘッダーコントロールの実装依存であり、そのため MMC はその値を関知しません。

戻り値

このメソッドは次の値のいずれかを返すことがあります。

vtbl 10 HRESULT SetColumnFilter(DWORD nColumn, DWORD dwType, MMC_FILTERDATA* pFilterData)

IHeaderCtrl2::SetColumnFilter は、フィルター済みリスト内の指定した列に対して、フィルター値とその最大文字長を設定します。

nColumnDWORDinフィルター値とその最大文字長を設定する列を識別する 0 から始まるインデックス。
dwTypeDWORDin指定した列に適用するフィルターの種類。 MMC_FILTER_TYPE 列挙体から取得します。
pFilterDataMMC_FILTERDATA*in実際のフィルターデータを保持する MMC_FILTERDATA 構造体へのポインター。

戻り値

このメソッドは次の値のいずれかを返すことがあります。

解説(Remarks)

フィルター値の設定と読み取りのいずれの場合も、 MMC_FILTERDATA 構造体および任意のテキストバッファーはスナップインが所有します。

スナップインが IHeaderCtrl2::SetColumnFilter を呼び出してフィルター済みリスト内の列のフィルターデータを明示的に設定しない場合、フィルターの種類は既定で MMC_STRING_FILTER となり、フィルターの既定値はありません(MMC_FILTER_NOVALUE)。フィルターの既定の長さは Win32 ヘッダーコントロールでは文書化されていませんが、想定されるほとんどのユーザー入力に対して十分な長さがあります。スナップインが特定の長さを必要とする場合は、IHeaderCtrl2::SetColumnFilter を呼び出す必要があります。

vtbl 11 HRESULT GetColumnFilter(DWORD nColumn, DWORD* pdwType, MMC_FILTERDATA* pFilterData)

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

nColumnDWORDinフィルター値とその最大文字長を取得する列を識別する 0 から始まるインデックス。
pdwTypeDWORD*inoutMMC_FILTER_TYPE 列挙体で指定される可能なフィルター値のいずれかを取ることができる DWORD 型の変数へのポインター。指定した列のフィルターの種類は、pdwType が指すアドレスに格納されます。
pFilterDataMMC_FILTERDATA*inout実際のフィルターデータを保持する MMC_FILTERDATA 構造体へのポインター。

戻り値

このメソッドは次の値のいずれかを返すことがあります。

解説(Remarks)

フィルター値の設定と読み取りのいずれの場合も、 MMC_FILTERDATA 構造体および任意のテキストバッファーはスナップインが所有します。

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IHeaderCtrl2 "{9757ABB8-1B32-11D1-A7CE-00C04FD8D565}"
#usecom global IHeaderCtrl2 IID_IHeaderCtrl2 "{}"
#comfunc global IHeaderCtrl2_SetChangeTimeOut  9 int
#comfunc global IHeaderCtrl2_SetColumnFilter   10 int,int,var
#comfunc global IHeaderCtrl2_GetColumnFilter   11 int,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。