Win32 API 日本語リファレンス
ホームUI.TextServices › ITfMenu

ITfMenu

COM
IID6f8a98e4-aaa0-4f15-8c5b-07e0df0a3dd8継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfMenu インターフェイスは言語バーによって実装され、言語バーのボタン プロバイダーが、言語バーがそのボタンに対して表示するメニューへ項目を追加するために使用します。

メソッド 1

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

vtbl 3 HRESULT AddMenuItem(DWORD uId, DWORD dwFlags, HBITMAP hbmp, HBITMAP hbmpMask, LPWSTR pch, DWORD cch, ITfMenu** ppMenu)

ITfMenu::AddMenuItem メソッド

uIdDWORDinメニュー項目の識別子を格納します。
dwFlagsDWORDinメニュー項目の種類と状態を指定する TF_LBMENUF_* 値の 0 個、または 1 個以上の組み合わせを格納します。
hbmpHBITMAPinメニュー項目に描画されるビットマップのハンドルを格納します。NULL の場合、メニュー項目にビットマップは表示されません。
hbmpMaskHBITMAPin

マスク ビットマップのハンドルを格納します。これは hbmp のマスクとして機能するモノクロ ビットマップです。このビットマップ内の黒いピクセルは、hbmp の対応するピクセルを通常の色で表示させます。白いピクセルは、hbmp の対応するピクセルを通常の色の反転色で表示させます。

色の変換を行わずにビットマップを表示するには、hbmp と同じサイズのモノクロ ビットマップを作成し、すべてのピクセルを黒 (RGB(0, 0, 0)) に設定します。

hbmpNULL の場合、このパラメーターは無視されます。

pchLPWSTRinメニュー項目に表示するテキストを格納する WCHAR バッファーへのポインター。テキストの長さは cch で指定します。
cchDWORDinpch に格納されたメニュー項目テキストの長さを WCHAR 単位で指定します。
ppMenuITfMenu**inout

[in, out] サブメニュー オブジェクトを受け取る ITfMenu インターフェイス ポインターへのポインター。dwFlagsTF_LBMENUF_SUBMENU が含まれない場合、このパラメーターは使用されず、NULL でなければなりません。

サブメニュー項目の作成に成功すると、このパラメーターは、呼び出し元がサブメニューへ項目を追加するために使用する ITfMenu オブジェクトを受け取ります。

dwFlagsTF_LBMENUF_SUBMENU が含まれる場合、この値はこのメソッドを呼び出す前に NULL に初期化しておく必要があります。これは多くの場合マーシャリングされた呼び出しであるためです。この変数を初期化しないと、マーシャラーが不定のメモリにアクセスしようとする結果になります。

戻り値

このメソッドは次のいずれかの値を返します。

説明
S_OK
メソッドは成功しました。
E_FAIL
特定できないエラーが発生しました。
E_OUTOFMEMORY
メモリ割り当てに失敗しました。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfMenu "{6F8A98E4-AAA0-4F15-8C5B-07E0DF0A3DD8}"
#usecom global ITfMenu IID_ITfMenu "{}"
#comfunc global ITfMenu_AddMenuItem  3 int,int,sptr,sptr,wstr,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。