IOleDocument::EnumViews メソッド (docobj.h)

  • [アーティクル]

ドキュメント オブジェクトでサポートされているビューを列挙するオブジェクトを作成します。1 つのビューのみがサポートされている場合は、そのビューへのポインターを返します。

構文

HRESULT EnumViews(
  [out] IEnumOleDocumentViews **ppEnum,
  [out] IOleDocumentView      **ppView
);

パラメーター

[out] ppEnum

列挙子オブジェクトへのインターフェイス ポインターを受け取る IEnumOleDocumentViews ポインター変数へのポインター。

[out] ppView

1 つのビュー オブジェクトへのインターフェイス ポインターを受け取る IOleDocumentView ポインター変数へのポインター。

戻り値

このメソッドは、オブジェクトが複数のビューをサポートしている場合にS_OKを返し、 ppEnum には列挙子オブジェクトへのポインターが含まれており、 ppView は NULL です。 それ以外の場合、 ppEnum は NULL で、 ppView には単一ビュー上のインターフェイス ポインターが含まれます。

その他の可能な戻り値は次のとおりです。

リターン コード 説明
E_OUTOFMEMORY
 操作に使用できるメモリが不足しています。
E_POINTER
 ppEnum または ppView のアドレスが無効です。 呼び出し元は、両方の引数に対して有効なポインターを渡す必要があります。

解説

ドキュメント オブジェクトがデータの複数のビューをサポートしている場合は、 IEnumOleDocumentViews も実装し、out パラメーター ppEnum でそのインターフェイスのポインターを渡す必要があります。 このポインターを使用して、コンテナーはドキュメント オブジェクトでサポートされているビューを列挙できます。

ドキュメント オブジェクトが 1 つのビューのみをサポートしている場合、IOleDocument::EnumViews は out パラメーター ppView でそのビューの IOleDocumentView ポインターを渡します。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー docobj.h

関連項目

IEnumOleDocumentViews

IOleDocument

IOleDocumentView