ホーム › UI.TextServices › IEnumTfCandidates

IEnumTfCandidates

COM

📘 Microsoft Learn (日本語) · English

IIDdefb1926-6c80-4ce8-87d4-d6b72b812bde継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumTfCandidates インターフェイスはテキストサービスによって実装され、候補文字列オブジェクトの列挙を提供するために TSF マネージャーによって使用されます。

メソッド 4

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

vtbl 3 HRESULT Clone(IEnumTfCandidates** ppEnum)

IEnumTfCandidates::Clone メソッド

ppEnum

IEnumTfCandidates**

out

新しい列挙子を受け取る IEnumTfCandidates インターフェイスポインターへのポインター。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_OUTOFMEMORY	メモリの割り当てに失敗しました。

vtbl 4 HRESULT Next(DWORD ulCount, ITfCandidateString** ppCand, DWORD* pcFetched)

IEnumTfCandidates::Next メソッド

ulCount	DWORD	in	取得する要素の数を指定します。
ppCand	ITfCandidateString**	out	要求されたオブジェクトを受け取る ITfCandidateString インターフェイスポインターの配列へのポインター。この配列のサイズは、少なくとも ulCount 個の要素分が必要です。
pcFetched	DWORD*	out	取得された要素の数を受け取る ULONG 値へのポインター。この値は、要求された項目数より少ない場合があります。このパラメーターには NULL を指定できます。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
S_FALSE	指定された数の要素を取得する前に、列挙の末尾に達しました。
E_INVALIDARG	ppCand が無効です。

vtbl 5 HRESULT Reset()

IEnumTfCandidates::Reset メソッド

戻り値

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

値	説明
S_OK	メソッドは成功しました。

vtbl 6 HRESULT Skip(DWORD ulCount)

IEnumTfCandidates::Skip メソッド

ulCount

DWORD

スキップする要素の数を格納します。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
S_FALSE	指定された数の要素をスキップする前に、列挙の末尾に達しました。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IEnumTfCandidates "{DEFB1926-6C80-4CE8-87D4-D6B72B812BDE}"
#usecom global IEnumTfCandidates IID_IEnumTfCandidates "{}"
#comfunc global IEnumTfCandidates_Clone  3 sptr
#comfunc global IEnumTfCandidates_Next   4 int,sptr,var
#comfunc global IEnumTfCandidates_Reset  5
#comfunc global IEnumTfCandidates_Skip   6 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEnumTfCandidates "{DEFB1926-6C80-4CE8-87D4-D6B72B812BDE}"
#usecom global IEnumTfCandidates IID_IEnumTfCandidates "{}"
#comfunc global IEnumTfCandidates_Clone  3 sptr
#comfunc global IEnumTfCandidates_Next   4 int,sptr,sptr
#comfunc global IEnumTfCandidates_Reset  5
#comfunc global IEnumTfCandidates_Skip   6 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。