IConsoleVerb

COM

IIDe49f7a60-74af-11d0-a286-00c04fd8fe93継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IConsoleVerb インターフェースは、スナップインが cut、copy、paste、delete、properties、rename、refresh、print などの標準の verb を有効化できるようにします。項目が選択されると、スナップインはこれらの verb の状態を更新できます。

解説(Remarks)

IID_IConsoleVerb は E49F7A60-74AF-11D0-A286-00C04FD8FE93 として定義されています。

メソッド 4

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

vtbl 3 HRESULT GetVerbState(MMC_CONSOLE_VERB eCmdID, MMC_BUTTON_STATE nState, BOOL* pState)

GetVerbState メソッドは、スナップインが指定した verb の現在の状態を取得できるようにします。

eCmdID	MMC_CONSOLE_VERB	in	verb のコマンド識別子を指定する値です。 MMC_CONSOLE_VERB 列挙型から取得します。この値に MMC_VERB_NONE を指定することはできません。
nState	MMC_BUTTON_STATE	in	ボタンの取り得る状態を識別する値です。 MMC_BUTTON_STATE 列挙型から取得します。
pState	BOOL*	out	返される状態情報へのポインターです。状態が有効または非表示の場合は TRUE、無効または表示の場合は FALSE になります。

戻り値

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

解説(Remarks)

項目が選択されると、すべてのコマンドの verb 状態は無効かつ非表示にリセットされます。項目が選択されたときに verb の状態を更新するのは、スナップイン開発者の責任です。

vtbl 4 HRESULT SetVerbState(MMC_CONSOLE_VERB eCmdID, MMC_BUTTON_STATE nState, BOOL bState)

SetVerbState メソッドは、スナップインが指定した verb のボタン状態を設定できるようにします。

eCmdID	MMC_CONSOLE_VERB	in	verb のコマンド識別子を指定する値です。値は MMC_CONSOLE_VERB 列挙型から取得します。この値に MMC_VERB_NONE を指定することはできません。
nState	MMC_BUTTON_STATE	in	ボタンの取り得る状態を識別します。 MMC_BUTTON_STATE 列挙型から取得します。
bState	BOOL	in	この値は、verb を有効化または非表示にする場合は TRUE、選択した verb を無効化または表示する場合は FALSE です。

戻り値

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

vtbl 5 HRESULT SetDefaultVerb(MMC_CONSOLE_VERB eCmdID)

SetDefaultVerb メソッドは、オブジェクトに対する既定のアクションを設定します。

eCmdID

MMC_CONSOLE_VERB

既定の verb です。

戻り値

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

解説(Remarks)

MMC_CONSOLE_VERB 列挙型は、既定の verb のセットを定義します。スナップインは任意の verb を既定の verb として設定できます。既定の verb を設定すると、MMC は次の処理を行います。

その verb のコンテキストメニュー項目を太字で表示します。
スナップインが MMCN_DBLCLICK 通知ハンドラーで S_FALSE を返した場合、既定のアクションを実行します(properties と open の verb のみ)。

vtbl 6 HRESULT GetDefaultVerb(MMC_CONSOLE_VERB* peCmdID)

GetDefaultVerb メソッドは、スナップインの既定の verb を取得します。

peCmdID

MMC_CONSOLE_VERB*

out

スナップインの既定の verb が返される場所へのポインターです。

戻り値

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

解説(Remarks)

MMC_CONSOLE_VERB 列挙型は、既定の verb のセットを定義します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IConsoleVerb "{E49F7A60-74AF-11D0-A286-00C04FD8FE93}"
#usecom global IConsoleVerb IID_IConsoleVerb "{}"
#comfunc global IConsoleVerb_GetVerbState    3 int,int,var
#comfunc global IConsoleVerb_SetVerbState    4 int,int,int
#comfunc global IConsoleVerb_SetDefaultVerb  5 int
#comfunc global IConsoleVerb_GetDefaultVerb  6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IConsoleVerb "{E49F7A60-74AF-11D0-A286-00C04FD8FE93}"
#usecom global IConsoleVerb IID_IConsoleVerb "{}"
#comfunc global IConsoleVerb_GetVerbState    3 int,int,sptr
#comfunc global IConsoleVerb_SetVerbState    4 int,int,int
#comfunc global IConsoleVerb_SetDefaultVerb  5 int
#comfunc global IConsoleVerb_GetDefaultVerb  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。