ホーム › System.Ole › IEnumOleUndoUnits

IEnumOleUndoUnits

COM

📘 Microsoft Learn (日本語) · English

IIDb3e7c340-ef97-11ce-9bc9-00aa00608e01継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

Undo スタックまたは Redo スタック上の Undo 単位を列挙します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD cElt, IOleUndoUnit** rgElt, DWORD* pcEltFetched)

列挙シーケンス内の指定した数の項目を取得します。(IEnumOleUndoUnits.Next)

cElt

DWORD

取得する項目の数。シーケンスに残っている項目が要求された数より少ない場合、このメソッドは残りの要素を取得します。

rgElt

IOleUndoUnit**

out

列挙された項目の配列。

列挙子は AddRef を呼び出す責任を負い、呼び出し元は列挙された各ポインターに対して Release を呼び出す責任を負います。cElt が 1 より大きい場合、呼び出し元は解放すべきポインターの数を知るために、pcEltFetched に非 NULL のポインターも渡す必要があります。

pcEltFetched

DWORD*

out

取得された項目の数。このパラメーターは常に、要求された項目数以下になります。

戻り値

要求された数の項目を取得できた場合、戻り値は S_OK です。それ以外の場合は S_FALSE です。

解説(Remarks)

このメソッドが正常に返された後、呼び出し元は配列内の各要素に対して Release メソッドを呼び出す責任を負います。cUndoUnits が 1 より大きい場合、呼び出し元は解放すべきポインターの数を取得するために、pcFetched に非 NULL のポインターも渡す必要があります。

E_NOTIMPL を戻り値として使用することはできません。エラー値が返された場合、終了時に rgpcd 配列内のエントリはいずれも有効ではなく、解放は不要です。

vtbl 4 HRESULT Skip(DWORD cElt)

列挙シーケンス内の指定した数の項目をスキップします。(IEnumOleUndoUnits.Skip)

cElt

DWORD

スキップする項目の数。

戻り値

要求された数の項目をスキップできた場合、戻り値は S_OK です。それ以外の場合は S_FALSE です。

vtbl 5 HRESULT Reset()

列挙シーケンスを先頭にリセットします。(IEnumOleUndoUnits.Reset)

戻り値

このメソッドは成功時に S_OK を返します。

解説(Remarks)

リセット操作の完了後に、同じオブジェクトの集合が列挙されるという保証はありません。静的なコレクションは先頭にリセットされますが、ディレクトリ内のファイルなど一部のコレクションでは、この条件を保証するコストが高すぎる場合があります。

vtbl 6 HRESULT Clone(IEnumOleUndoUnits** ppEnum)

現在の列挙子と同じ列挙状態を持つ新しい列挙子を作成します。(IEnumOleUndoUnits.Clone)

ppEnum

IEnumOleUndoUnits**

out

新しく作成された列挙子の IEnumOleUndoUnits インターフェイスポインターへのポインター。呼び出し元は、この列挙子を、複製元の列挙子とは別に解放する必要があります。

戻り値

このメソッドは成功時に S_OK を返します。その他に返される可能性のある値は次のとおりです。

戻り値のコード	説明
E_UNEXPECTED	予期しないエラーが発生しました。
E_INVALIDARG	指定された列挙子が無効です。
E_OUTOFMEMORY	この操作に利用できるメモリが不足しています。

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