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

IEnumTfDocumentMgrs

COM
IIDaa80e808-2021-11d2-93e0-0060b067b86e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumTfDocumentMgrs インターフェイスは TSF マネージャーによって実装され、ドキュメントマネージャーオブジェクトの列挙を提供します。

メソッド 4

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

vtbl 3 HRESULT Clone(IEnumTfDocumentMgrs** ppEnum)

IEnumTfDocumentMgrs::Clone メソッド

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

戻り値

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

説明
S_OK
メソッドは成功しました。
E_OUTOFMEMORY
メモリの割り当てに失敗しました。
vtbl 4 HRESULT Next(DWORD ulCount, ITfDocumentMgr** rgDocumentMgr, DWORD* pcFetched)

IEnumTfDocumentMgrs::Next メソッド

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

戻り値

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

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

IEnumTfDocumentMgrs::Reset メソッド

戻り値

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

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

IEnumTfDocumentMgrs::Skip メソッド

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

戻り値

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

説明
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_IEnumTfDocumentMgrs "{AA80E808-2021-11D2-93E0-0060B067B86E}"
#usecom global IEnumTfDocumentMgrs IID_IEnumTfDocumentMgrs "{}"
#comfunc global IEnumTfDocumentMgrs_Clone  3 sptr
#comfunc global IEnumTfDocumentMgrs_Next   4 int,sptr,var
#comfunc global IEnumTfDocumentMgrs_Reset  5
#comfunc global IEnumTfDocumentMgrs_Skip   6 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。