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

IInkWordList

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID76ba3491-cb2f-406b-9961-0e0c4cdaaef2継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

. (IInkWordList)

メソッド 3

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT AddWord(LPWSTR NewWord)

InkWordList オブジェクトに単語を 1 つ追加します。

NewWordLPWSTRin

InkWordList オブジェクトに追加する単語。単語が既にリストに存在する場合は追加されません。

BSTR データ型の詳細については、Using the COM Library を参照してください。

戻り値

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

戻り値 説明
S_OK
成功しました。
S_FALSE
単語は既にリストに存在します。
E_OUTOFMEMORY
操作を完了するためのメモリを割り当てられません。
E_FAIL
不特定のエラーが発生しました。
E_POINTER
パラメーターに無効なポインターが含まれていました。
E_INK_EXCEPTION
メソッド内部で例外が発生しました。

解説(Remarks)

単語リストに文字列を追加すると、その大文字化されたバージョンも暗黙的に追加されます。たとえば "hello" を追加すると、"Hello" と "HELLO" も暗黙的に追加されます。

vtbl 8 HRESULT RemoveWord(LPWSTR RemoveWord)

InkWordList から単語を 1 つ削除します。

RemoveWordLPWSTRin

InkWordList から削除する単語。

BSTR データ型の詳細については、Using the COM Library を参照してください。

戻り値

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

戻り値 説明
S_OK
成功しました。
E_OUTOFMEMORY
操作を完了するためのメモリを割り当てられません。
E_FAIL
不特定のエラーが発生しました。
E_POINTER
パラメーターに無効なポインターが含まれていました。
E_INK_EXCEPTION
メソッド内部で例外が発生しました。

解説(Remarks)

単語リストに文字列を追加すると、その大文字化されたバージョンも暗黙的に追加されます。たとえば "hello" を追加すると、"Hello" と "HELLO" も暗黙的に追加されます。そのため、"hello" を削除すると "Hello" と "HELLO" も暗黙的に削除されます。ただし、"hello" を追加した後に "Hello" を削除しようとしても、"Hello" は明示的に追加されていないため、RemoveWord の呼び出しは効果がありません。

vtbl 9 HRESULT Merge(IInkWordList* MergeWordList)

指定した InkWordList オブジェクトをこの単語リストにマージします。

MergeWordListIInkWordList*inoptionalこの単語リストにマージする単語リスト。リストに既に存在する単語は追加されません。

戻り値

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

戻り値 説明
S_OK
成功しました。
E_POINTER
パラメーターに無効なポインターが含まれていました。
E_OUTOFMEMORY
操作を完了するためのメモリを割り当てられません。
E_FAIL
不特定のエラーが発生しました。
E_INK_EXCEPTION
メソッド内部で例外が発生しました。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IInkWordList "{76BA3491-CB2F-406B-9961-0E0C4CDAAEF2}"
#usecom global IInkWordList IID_IInkWordList "{9DE85094-F71F-44F1-8471-15A2FA76FCF3}"
#comfunc global IInkWordList_AddWord     7 wstr
#comfunc global IInkWordList_RemoveWord  8 wstr
#comfunc global IInkWordList_Merge       9 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。