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

ITfCandidateString

COM
📘 Microsoft Learn (日本語) · English
IID581f317e-fd9d-443f-b972-ed00467c5d40継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfCandidateString インターフェイスはテキストサービスによって実装され、TSF マネージャーまたはクライアントが候補文字列オブジェクトに関する情報を取得するために使用します。

メソッド 2

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

vtbl 3 HRESULT GetString(LPWSTR* pbstr)

ITfCandidateString::GetString メソッド

pbstrLPWSTR*out候補文字列オブジェクトのテキストを受け取る BSTR 値へのポインター。呼び出し元は、不要になった時点で SysFreeString を使用してこのメモリを解放する必要があります。

戻り値

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

値 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
 pbstr が無効です。
E_OUTOFMEMORY
 メモリの割り当てに失敗しました。
vtbl 4 HRESULT GetIndex(DWORD* pnIndex)

ITfCandidateString::GetIndex メソッド

pnIndexDWORD*out候補一覧内における候補文字列オブジェクトの 0 から始まるインデックスを受け取る ULONG 値へのポインター。

戻り値

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

値 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
 pnIndex が無効です。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfCandidateString "{581F317E-FD9D-443F-B972-ED00467C5D40}"
#usecom global ITfCandidateString IID_ITfCandidateString "{}"
#comfunc global ITfCandidateString_GetString  3 var
#comfunc global ITfCandidateString_GetIndex   4 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。