ホーム › UI.Shell › ICategorizer

ICategorizer

COM

📘 Microsoft Learn (日本語) · English

IIDa3b14589-9174-49a8-89a3-06a1ae2b9ba7継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

アイテム識別子リストに関する情報を取得するために使用されるメソッドを公開します。

メソッド 4

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

vtbl 3 HRESULT GetDescription(LPWSTR pszDesc, DWORD cch)

UI に表示できる、Group By Device Type などのカテゴライザーの名前を取得します。

pszDesc	LPWSTR	out	このメソッドが返るときに、カテゴライザー名を含む長さ cch の文字列へのポインターが格納されます。
cch	DWORD	in	pszDesc バッファー内の文字数。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

システムフォルダービューオブジェクトの場合、pszDesc の説明がフォルダーの アイコンの整列 メニューに列挙されているカテゴリ名のいずれかと一致すると、表示メニューまたはコンテキストメニューからメニューが表示される際に、その名前の横にドットが表示されます。

vtbl 4 HRESULT GetCategory(DWORD cidl, ITEMIDLIST** apidl, DWORD* rgCategoryIds)

識別子のリストに関連付けられたカテゴリのリストを取得します。

cidl	DWORD	in	アイテム識別子リスト配列内のアイテム数。
apidl	ITEMIDLIST**	in	cidl 個のアイテム識別子リストポインターの配列へのポインター。
rgCategoryIds	DWORD*	out	このメソッドが返るときに、cidl 個のカテゴリ識別子の配列へのポインターが格納されます。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

ICategorizer::GetCategory メソッドは、アイテム識別子リスト (PIDL) へのポインターの配列を受け取り、カテゴリ識別子の配列を設定します。

重要値 -1 は無効なカテゴリ識別子です。

vtbl 5 HRESULT GetCategoryInfo(DWORD dwCategoryId, CATEGORY_INFO* pci)

既定の表示や UI に表示するテキストなど、カテゴリに関する情報を取得します。

dwCategoryId	DWORD	in	カテゴリ識別子を指定する DWORD。
pci	CATEGORY_INFO*	out	このメソッドが返るときに、カテゴリ情報を含む CATEGORY_INFO 構造体へのポインターが格納されます。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 6 HRESULT CompareCategory(CATSORT_FLAGS csfFlags, DWORD dwCategoryId1, DWORD dwCategoryId2)

アイテム識別子リスト内における 2 つのアイテムの相対的な順序、ひいては UI 上での順序を決定します。

csfFlags	CATSORT_FLAGS	in	比較の実行方法を指定するフラグ。このパラメーターは CATSORT_FLAGS の値のいずれかである必要があります。
dwCategoryId1	DWORD	in	比較に使用する 1 つ目のカテゴリ識別子を指定する DWORD。
dwCategoryId2	DWORD	in	比較に使用する 2 つ目のカテゴリ識別子を指定する DWORD。

戻り値

型: HRESULT

このメソッドが成功すると、HRESULT の CODE フィールドに比較結果を示す値が格納されます。それ以外の場合は COM エラーコードを返します。

解説(Remarks)

次の表は、HRESULT の CODE フィールドに返される値を示します。

ゼロ未満	1 つ目のアイテムは 2 つ目のアイテムより前に配置されるべきです (dwCategoryId1 < dwCategoryId2)。
ゼロより大きい	1 つ目のアイテムは 2 つ目のアイテムより後に配置されるべきです (dwCategoryId1 > dwCategoryId2)。
ゼロ	2 つのアイテムは同じです (dwCategoryId1 = dwCategoryId2)。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ICategorizer "{A3B14589-9174-49A8-89A3-06A1AE2B9BA7}"
#usecom global ICategorizer IID_ICategorizer "{}"
#comfunc global ICategorizer_GetDescription   3 var,int
#comfunc global ICategorizer_GetCategory      4 int,var,var
#comfunc global ICategorizer_GetCategoryInfo  5 int,var
#comfunc global ICategorizer_CompareCategory  6 int,int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_ICategorizer "{A3B14589-9174-49A8-89A3-06A1AE2B9BA7}"
#usecom global ICategorizer IID_ICategorizer "{}"
#comfunc global ICategorizer_GetDescription   3 sptr,int
#comfunc global ICategorizer_GetCategory      4 int,sptr,sptr
#comfunc global ICategorizer_GetCategoryInfo  5 int,sptr
#comfunc global ICategorizer_CompareCategory  6 int,int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。