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

ドキュメント オブジェクトに関する状態情報を取得します。

構文

HRESULT GetDocMiscStatus(
  [out] DWORD *pdwStatus
);

パラメーター

[out] pdwStatus

サポートされている動作に関する情報へのポインター。 指定できる値は DOCMISC 列挙から取得されます。

戻り値

このメソッドは、成功したS_OKを返します。 その他の可能な戻り値は次のとおりです。

リターン コード 説明
E_POINTER
pdwStatus のアドレスは NULL です

解説

このメソッドは、ドキュメント オブジェクトが複数のビュー、複雑な四角形、ポップアップ ウィンドウで開く、またはファイルの読み取り/書き込みをサポートしているかどうかをコンテナーが確認する方法を提供します。

この列挙子の値は、DocObject キーの値としてレジストリにも格納されます。

呼び出し元へのメモ

ドキュメント オブジェクトをアクティブ化する前にこのメソッドを呼び出すことで、コンテナーは、指定された動作をサポートしたり、それ以外の場合に対応するために必要な手順を実行したりできます。

実装者へのメモ

pdwStatus の逆参照値が 0 の場合でも、このメソッドはドキュメント オブジェクトに完全に実装する必要があります。 E_NOTIMPLは許容される戻り値ではありません。 通常、返される DOCMISC 値は、パフォーマンスのためにハードコーディングする必要があります。

要件

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

関連項目

DOCMISC

IOleDocument