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

IEnumTfUIElements

COM
IID887aa91e-acba-4931-84da-3c5208cf543f継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumTfUIElements インターフェイスは TSF マネージャーによって実装され、アプリケーションまたはテキストサービスから使用されます。このインターフェイスは ITfUIElementMgr::EnumUIElements で取得でき、登録されている UI 要素を列挙します。

メソッド 4

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

vtbl 3 HRESULT Clone(IEnumTfUIElements** ppEnum)

IEnumTfUIElements::Clone メソッドは、列挙子オブジェクトのコピーを作成します。

ppEnumIEnumTfUIElements**out[out] IEnumTfUIElements インターフェイスへのポインターです。

戻り値

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

説明
S_OK
メソッドは成功しました。
E_FAIL
不特定のエラーが発生しました。
E_INVALIDARG
1 つ以上のパラメーターが無効です。
vtbl 4 HRESULT Next(DWORD ulCount, ITfUIElement** ppElement, DWORD* pcFetched)

IEnumTfUIElements::Next メソッドは、現在の位置から、列挙シーケンス内の指定された数の要素を取得します。

ulCountDWORDin[out] 取得する要素の数を指定します。
ppElementITfUIElement**out[out] ITfUIElement インターフェイスポインターの配列へのポインターです。この配列は少なくとも ulCount 個の要素のサイズが必要です。
pcFetchedDWORD*out[out] 実際に取得された要素数を受け取る ULONG 値へのポインターです。この値は要求された項目数より少ない場合があります。このパラメーターには NULL を指定できます。

戻り値

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

説明
S_OK
メソッドは成功しました。
S_FALSE
指定された数の要素を取得する前に、列挙の末尾に達しました。
E_INVALIDARG
1 つ以上のパラメーターが無効です。
vtbl 5 HRESULT Reset()

IEnumTfUIElements::Reset メソッドは、現在の位置を列挙シーケンスの先頭に移動して、列挙子オブジェクトをリセットします。

戻り値

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

説明
S_OK
メソッドは成功しました。
vtbl 6 HRESULT Skip(DWORD ulCount)

IEnumTfUIElements::Skip メソッドは、現在の位置から、列挙シーケンス内の指定された数の要素をスキップします。

ulCountDWORDin[in] スキップする要素の数を指定します。

戻り値

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

説明
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_IEnumTfUIElements "{887AA91E-ACBA-4931-84DA-3C5208CF543F}"
#usecom global IEnumTfUIElements IID_IEnumTfUIElements "{}"
#comfunc global IEnumTfUIElements_Clone  3 sptr
#comfunc global IEnumTfUIElements_Next   4 int,sptr,var
#comfunc global IEnumTfUIElements_Reset  5
#comfunc global IEnumTfUIElements_Skip   6 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。