ホーム › System.Ole › IEnumOleDocumentViews

IEnumOleDocumentViews

COM

📘 Microsoft Learn (日本語) · English

IIDb722bcc8-4e68-101b-a2bc-00aa00404770継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ドキュメントオブジェクトがサポートするビューを列挙します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD cViews, IOleDocumentView** rgpView, DWORD* pcFetched)

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

cViews

DWORD

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

pcFetched が NULL の場合、このパラメーターは 1 でなければなりません。

rgpView

IOleDocumentView**

out

列挙された項目の配列。

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

pcFetched

DWORD*

out

取得された項目の数。このパラメーターは常に要求された項目数以下です。このパラメーターは NULL にすることができ、その場合 cViews パラメーターは 1 でなければなりません。

戻り値

メソッドが要求された数の項目を取得した場合、戻り値は S_OK です。それ以外の場合は S_FALSE です。

解説(Remarks)

E_NOTIMPL は戻り値として使用できません。エラー値が返された場合、rgpView 配列内のエントリはいずれも有効ではなく、Release の呼び出しは不要です。

vtbl 4 HRESULT Skip(DWORD cViews)

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

cViews

DWORD

スキップする項目の数。

戻り値

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

vtbl 5 HRESULT Reset()

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

戻り値

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

解説(Remarks)

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

vtbl 6 HRESULT Clone(IEnumOleDocumentViews** ppEnum)

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

ppEnum

IEnumOleDocumentViews**

out

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

戻り値

このメソッドは成功時に 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_IEnumOleDocumentViews "{B722BCC8-4E68-101B-A2BC-00AA00404770}"
#usecom global IEnumOleDocumentViews IID_IEnumOleDocumentViews "{}"
#comfunc global IEnumOleDocumentViews_Next   3 int,sptr,var
#comfunc global IEnumOleDocumentViews_Skip   4 int
#comfunc global IEnumOleDocumentViews_Reset  5
#comfunc global IEnumOleDocumentViews_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEnumOleDocumentViews "{B722BCC8-4E68-101B-A2BC-00AA00404770}"
#usecom global IEnumOleDocumentViews IID_IEnumOleDocumentViews "{}"
#comfunc global IEnumOleDocumentViews_Next   3 int,sptr,sptr
#comfunc global IEnumOleDocumentViews_Skip   4 int
#comfunc global IEnumOleDocumentViews_Reset  5
#comfunc global IEnumOleDocumentViews_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。