ISnapinAbout
COM公式ドキュメント
ISnapinAbout インターフェースを使用すると、コンソールはスナップインから著作権情報とバージョン情報を取得できます。また、コンソールはこのインターフェースを使用して、スナップインから静的フォルダー用のイメージを取得します。
メソッド 5
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
コンソールがスナップインの説明ボックス用のテキストを取得できるようにします。
| lpDescription | LPWSTR* | out | About プロパティページの説明ボックス用のテキストへのポインター。 |
戻り値
このメソッドは、次のいずれかの値を返します。
解説(Remarks)
説明は、スナップインマネージャーのプロパティページの説明ウィンドウに収まるよう、4 行以内のテキストに制限してください。
出力パラメーターのメモリは、COM API 関数 CoTaskMemAlloc を使用して割り当てる必要があります。
ISnapinAbout::GetProvider メソッドを使用すると、コンソールはスナップインのプロバイダー名を取得できます。
| lpName | LPWSTR* | out | スナップインのプロバイダー名のテキストへのポインター。 |
戻り値
このメソッドは、次のいずれかの値を返します。
解説(Remarks)
出力パラメーターのメモリは、COM API 関数 CoTaskMemAlloc を使用して割り当てる必要があります。
コンソールがスナップインのバージョン番号を取得できるようにします。
| lpVersion | LPWSTR* | out | スナップインのバージョン番号のテキストへのポインター。 |
戻り値
このメソッドは、次のいずれかの値を返します。
解説(Remarks)
出力パラメーターのメモリは、COM 関数 CoTaskMemAlloc を使用して割り当てる必要があります。
コンソールが About ボックスで使用するスナップインのメインアイコンを取得できるようにします。
| hAppIcon | HICON* | out | About プロパティページで使用されるスナップインのメインアイコンのハンドルへのポインター。 |
戻り値
このメソッドは、次のいずれかの値を返します。
解説(Remarks)
ビットマップの場合、MMC は透過マスクを生成するために特定の背景色を必要とします。一方、アイコンには透過性が組み込まれているため、MMC は特定の背景色を必要としません。
MMC は返されたアイコンのコピーを作成します。スナップインは、 ISnapinAbout インターフェースが解放された時点でアイコンを解放できます。
ISnapinAbout::GetStaticFolderImage メソッドを使用すると、コンソールはスコープペインと結果ペイン用の静的フォルダーイメージを取得できます。
| hSmallImage | HBITMAP* | out | スコープビューペインまたは結果ビューペインの小さいアイコン (16x16 ピクセル) のハンドルへのポインター。 |
| hSmallImageOpen | HBITMAP* | out | 小さい開いたフォルダーアイコン (16x16 ピクセル) のハンドルへのポインター。 |
| hLargeImage | HBITMAP* | out | 大きいアイコン (32x32 ピクセル) のハンドルへのポインター。 |
| cMask | COLORREF* | out | マスクの生成に使用される色を指定する COLORREF 構造体へのポインター。 |
戻り値
このメソッドは、次のいずれかの値を返します。
解説(Remarks)
MMC は返されたビットマップのコピーを作成します。スナップインは、 ISnapinAbout インターフェースが解放された時点で元のビットマップを解放できます。
MMC は、スナップインのアイコンを取得できない場合、既定の静的フォルダーイメージとアイコンを使用します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ISnapinAbout "{1245208C-A151-11D0-A7D7-00C04FD909DD}" #usecom global ISnapinAbout IID_ISnapinAbout "{}" #comfunc global ISnapinAbout_GetSnapinDescription 3 var #comfunc global ISnapinAbout_GetProvider 4 var #comfunc global ISnapinAbout_GetSnapinVersion 5 var #comfunc global ISnapinAbout_GetSnapinImage 6 sptr #comfunc global ISnapinAbout_GetStaticFolderImage 7 sptr,sptr,sptr,var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ISnapinAbout "{1245208C-A151-11D0-A7D7-00C04FD909DD}" #usecom global ISnapinAbout IID_ISnapinAbout "{}" #comfunc global ISnapinAbout_GetSnapinDescription 3 sptr #comfunc global ISnapinAbout_GetProvider 4 sptr #comfunc global ISnapinAbout_GetSnapinVersion 5 sptr #comfunc global ISnapinAbout_GetSnapinImage 6 sptr #comfunc global ISnapinAbout_GetStaticFolderImage 7 sptr,sptr,sptr,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。