IShellMenu

COM

IIDee1f7637-e138-11d1-8379-00c04fd918d0継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

スタートメニューやお気に入りメニューなどのシェルメニューを操作するメソッドを公開します。

解説(Remarks)

このインターフェイスへのポインターを取得するには、rclsid パラメーターに CLSID_MenuBand を、riid パラメーターに IID_IShellMenu を指定して CoCreateInstance を呼び出します。最初に IShellMenu::Initialize を呼び出してインターフェイスを初期化し、続いて IShellMenu::SetShellFolder を呼び出してメニューバンドを初期化する必要があります。

メソッド 9

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

vtbl 3 HRESULT Initialize(IShellMenuCallback* psmc, DWORD uId, DWORD uIdAncestor, DWORD dwFlags)

メニューバンドを初期化します。

psmc

IShellMenuCallback*

inoptional

IShellMenuCallback インターフェイスへのポインター。このインターフェイスはメニューからの通知を受け取ります。この値は NULL にすることができます。

uId

DWORD

選択されたメニュー項目の識別子。メニュー自体を指定するには、このパラメーターを -1 に設定します。

uIdAncestor

DWORD

dwFlags

DWORD

メニューの動作を制御するフラグ。

次のオプション値の組み合わせです。

値	意味
SMINIT_DEFAULT	オプションなし。
SMINIT_RESTRICT_DRAGDROP	ドラッグアンドドロップを許可しません。
SMINIT_TOPLEVEL	これが最上位バンドです。
SMINIT_CACHED	ウィンドウが閉じられてもバンドを破棄しません。

上記の値に加えて、次のレイアウトオプションのいずれかを指定します。

値	意味
SMINIT_VERTICAL	垂直バンドを指定します。
SMINIT_HORIZONTAL	水平バンドを指定します。

戻り値

型: HRESULT

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

vtbl 4 HRESULT GetMenuInfo(IShellMenuCallback** ppsmc, DWORD* puId, DWORD* puIdAncestor, DWORD* pdwFlags)

IShellMenu::Initialize メソッドから情報を取得します。

ppsmc	IShellMenuCallback**	outoptional	このメソッドが戻るとき、IShellMenu::Initialize を呼び出したときに指定した IShellMenuCallback インターフェイスへのポインターのアドレスを格納します。このポインターは NULL にすることができます。
puId	DWORD*	outoptional	このメソッドが戻るとき、IShellMenu::Initialize を呼び出したときに指定した uID 値を受け取る UINT 値へのポインターを格納します。このポインターは NULL にすることができます。
puIdAncestor	DWORD*	outoptional	このメソッドが戻るとき、IShellMenu::Initialize を呼び出したときに指定した uIdAncestor 値を受け取る UINT 値へのポインターを格納します。このポインターは NULL にすることができます。
pdwFlags	DWORD*	outoptional	このメソッドが戻るとき、IShellMenu::Initialize を呼び出したときに指定した dwFlags 値を受け取る DWORD 値へのポインターを格納します。このポインターは NULL にすることができます。

戻り値

型: HRESULT

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

vtbl 5 HRESULT SetShellFolder(IShellFolder* psf, ITEMIDLIST* pidlFolder, HKEY hKey, DWORD dwFlags)

メニューバンドが参照するフォルダーを指定します。

psf	IShellFolder*	inoptional	フォルダーの IShellFolder インターフェイスへのポインター。このポインターは NULL にすることができます。
pidlFolder	ITEMIDLIST*	inoptional	フォルダーの完全修飾された ITEMIDLIST。この値は NULL にすることができます。
hKey	HKEY	inoptional	メニューの順序を格納するために使用される "Order" 値を持つ HKEY。この値は NULL にすることができます。
dwFlags	DWORD	in	メニューバンドの動作を指定するフラグ。 SMSET_BOTTOM このフォルダーをメニューの一番下に配置します。 SMSET_USEBKICONEXTRACTION バックグラウンドアイコン抽出機能を使用します。 SMSET_HASEXPANDABLEFOLDERS このフォルダーには展開可能なフォルダーが含まれています。 SMSET_COLLAPSEONEMPTY 空の場合はメニューを折りたたみます。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドは IShellMenu::Initialize を呼び出した後に呼び出します。

vtbl 6 HRESULT GetShellFolder(DWORD* pdwFlags, ITEMIDLIST** ppidl, GUID* riid, void** ppv)

メニューバンドが参照するように設定されているフォルダーを取得します。

pdwFlags

DWORD*

out

このメソッドが正常に戻ると、メニューバンドの動作を指定する一連のフラグ値へのポインターを格納します。

次のいずれかのフラグを返すことができます。

値	意味
SMINIT_DEFAULT	オプションなし。
SMINIT_RESTRICT_DRAGDROP	ドラッグアンドドロップを許可しません。
SMINIT_TOPLEVEL	これが最上位バンドです。
SMINIT_CACHED	ウィンドウが閉じられてもバンドを破棄しません。

常に次のいずれかのフラグを返します。

値	意味
SMINIT_VERTICAL	垂直バンドを指定します。
SMINIT_HORIZONTAL	水平バンドを指定します。

ppidl

ITEMIDLIST**

out

このメソッドが戻るとき、フォルダーの完全修飾された ITEMIDLIST のアドレスを格納します。

riid

GUID*

対象フォルダーの REFIID。

ppv

void**

out

このメソッドが正常に戻ると、riid で参照されるシェルフォルダーオブジェクトへのポインターのアドレスを格納します。

戻り値

型: HRESULT

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

vtbl 7 HRESULT SetMenu(HMENU hmenu, HWND hwnd, DWORD dwFlags)

静的メニューをメニューバンドに追加します。

hmenu

HMENU

inoptional

追加する静的メニューのハンドル。この値は NULL にすることができます。

hwnd

HWND

inoptional

所有者ウィンドウの HWND。この値は NULL にすることができます。

dwFlags

DWORD

メニューの動作を指定するフラグ。

SMSET_BOTTOM

メニューを親メニューの一番下に付加します。

SMSET_TOP

メニューを親メニューの一番上に付加します。

SMSET_DONTOWN

メニューバンドは hwnd で指定されたメニューを所有しないため、最終的にそのメニューが置き換えられても破棄しないようにします。

戻り値

型: HRESULT

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

vtbl 8 HRESULT GetMenu(HMENU* phmenu, HWND* phwnd, DWORD* pdwFlags)

IShellMenu::SetMenu を呼び出して設定されたメニュー情報を取得します。

phmenu	HMENU*	outoptional	このメソッドが戻るとき、IShellMenu::SetMenu を呼び出したときに指定した hmenu 値を受け取る HMENU 値へのポインターを格納します。この値は NULL にすることができます。
phwnd	HWND*	outoptional	このメソッドが戻るとき、IShellMenu::SetMenu を呼び出したときに指定した hwnd 値を受け取る HWND 値へのポインターを格納します。この値は NULL にすることができます。
pdwFlags	DWORD*	outoptional	このメソッドが戻るとき、IShellMenu::SetMenu を呼び出したときに指定した dwFlags 値を受け取る DWORD 値へのポインターを格納します。この値は NULL にすることができます。

戻り値

型: HRESULT

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

vtbl 9 HRESULT InvalidateItem(SMDATA* psmd, DWORD dwFlags)

メニューバンド内の項目を再描画します。

psmd	SMDATA*	inoptional	再描画する項目を識別する SMDATA 構造体へのポインター。メニュー全体を再描画するには、この値を NULL に設定します。
dwFlags	DWORD	in	メニューの再描画方法を制御するフラグ。psmd が NULL の場合は、dwFlags を SMINV_REFRESH に設定します。psmd が有効な SMDATA 構造体に設定されている場合は、dwFlags を SMINV_ID \| SMINV_REFRESH に設定します。

戻り値

型: HRESULT

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

vtbl 10 HRESULT GetState(SMDATA* psmd)

値が設定された SMDATA 構造体を取得します。

psmd

SMDATA*

out

このメソッドが戻るとき、メニューバンドに関する情報を格納した SMDATA 構造体へのポインターを格納します。

戻り値

型: HRESULT

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

vtbl 11 HRESULT SetMenuToolbar(IUnknown* punk, DWORD dwFlags)

メニューバンドにメニューを追加します。

punk

IUnknown*

QueryInterface メソッドで CLSID_MenuToolbarBase をサポートするオブジェクトへのポインター。

dwFlags

DWORD

メニューの動作を制御するフラグ。

SMSET_TOP

この名前空間をメニューの上部側に配置します。

SMSET_BOTTOM

この名前空間をメニューの下部側に配置します。

SMSET_DONTOWN

メニューバンドは参照カウントされないオブジェクトを所有しません。

戻り値

型: HRESULT

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IShellMenu "{EE1F7637-E138-11D1-8379-00C04FD918D0}"
#usecom global IShellMenu IID_IShellMenu "{}"
#comfunc global IShellMenu_Initialize      3 sptr,int,int,int
#comfunc global IShellMenu_GetMenuInfo     4 sptr,var,var,var
#comfunc global IShellMenu_SetShellFolder  5 sptr,var,sptr,int
#comfunc global IShellMenu_GetShellFolder  6 var,var,var,sptr
#comfunc global IShellMenu_SetMenu         7 sptr,sptr,int
#comfunc global IShellMenu_GetMenu         8 sptr,sptr,var
#comfunc global IShellMenu_InvalidateItem  9 var,int
#comfunc global IShellMenu_GetState        10 var
#comfunc global IShellMenu_SetMenuToolbar  11 sptr,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IShellMenu "{EE1F7637-E138-11D1-8379-00C04FD918D0}"
#usecom global IShellMenu IID_IShellMenu "{}"
#comfunc global IShellMenu_Initialize      3 sptr,int,int,int
#comfunc global IShellMenu_GetMenuInfo     4 sptr,sptr,sptr,sptr
#comfunc global IShellMenu_SetShellFolder  5 sptr,sptr,sptr,int
#comfunc global IShellMenu_GetShellFolder  6 sptr,sptr,sptr,sptr
#comfunc global IShellMenu_SetMenu         7 sptr,sptr,int
#comfunc global IShellMenu_GetMenu         8 sptr,sptr,sptr
#comfunc global IShellMenu_InvalidateItem  9 sptr,int
#comfunc global IShellMenu_GetState        10 sptr
#comfunc global IShellMenu_SetMenuToolbar  11 sptr,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。

IShellMenu

公式ドキュメント

解説(Remarks)

メソッド 9

戻り値

戻り値

SMSET_BOTTOM

SMSET_USEBKICONEXTRACTION

SMSET_HASEXPANDABLEFOLDERS

SMSET_COLLAPSEONEMPTY

戻り値

解説(Remarks)

戻り値

SMSET_BOTTOM

SMSET_TOP

SMSET_DONTOWN

戻り値

戻り値

戻り値

戻り値

SMSET_TOP

SMSET_BOTTOM

SMSET_DONTOWN

戻り値

HSP用 COM定義