ホーム › UI.Shell › IExplorerCommandState

IExplorerCommandState

COM

IIDbddacb60-7657-47ae-8445-d23e1acf82ae継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

コマンドの状態を取得するための単一のメソッドを公開します。

解説(Remarks)

実装するタイミング

コマンドの状態を(たとえば項目のプロパティに基づいて)動的に判定する必要がある場合に、このインターフェイスを実装します。このインターフェイスは IExplorerCommand::GetState と同じ機能を提供しますが、そのインターフェイスが持つ追加メソッドのオーバーヘッドはありません。コマンドの状態を計算するだけでよい場合は、IExplorerCommandState を実装してください。

使用するタイミング

IExplorerCommandState のメソッドを直接呼び出さないでください。ユーザーが項目に対してアクションを実行しようとすると、Windows エクスプローラーがご自身の IExplorerCommandState::GetState の実装を呼び出します。

メソッド 1

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

vtbl 3 HRESULT GetState(IShellItemArray* psiItemArray, BOOL fOkToBeSlow, DWORD* pCmdState)

指定した Shell 項目に関連付けられたコマンドの状態を取得します。

psiItemArray	IShellItemArray*	in	Shell 項目を表す単一の要素を持つ IShellItemArray へのポインター。
fOkToBeSlow	BOOL	in	verb オブジェクトが UI スレッドの応答を停止させる可能性のあるメモリを大量に消費する計算を実行すべきでない場合は FALSE。その場合、verb オブジェクトは E_PENDING を返してください。TRUE の場合は、それらの計算を実行できます。
pCmdState	DWORD*	out	このメソッドが正常に返されたときに、EXPCMDSTATE 定数で示される 1 つ以上の Windows エクスプローラーのコマンド状態を受け取る値へのポインター。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドは GetState と同じ機能を提供します。コマンドの状態を知るだけでよい場合は、IExplorerCommandState を使用してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IExplorerCommandState "{BDDACB60-7657-47AE-8445-D23E1ACF82AE}"
#usecom global IExplorerCommandState IID_IExplorerCommandState "{}"
#comfunc global IExplorerCommandState_GetState  3 sptr,int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IExplorerCommandState "{BDDACB60-7657-47AE-8445-D23E1ACF82AE}"
#usecom global IExplorerCommandState IID_IExplorerCommandState "{}"
#comfunc global IExplorerCommandState_GetState  3 sptr,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。