IOleClientSite::GetContainer メソッド (oleidl.h)

  • [アーティクル]

オブジェクトのコンテナーへのポインターを取得します。

構文

HRESULT GetContainer(
  [out] IOleContainer **ppContainer
);

パラメーター

[out] ppContainer

コンテナー オブジェクトへのインターフェイス ポインターを受け取る IOleContainer ポインター変数のアドレス。 エラーが発生した場合、実装では ppContainer を NULL に設定する必要があります。

戻り値

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

リターン コード 説明
OLE_E_NOT_SUPPORTED
 クライアント サイトは OLE 1 コンテナー内にあります。
E_NOINTERFACE
 コンテナーは IOleContainer インターフェイスを実装しません。

注釈

コンテナーが埋め込みオブジェクトへのリンクをサポートしている場合、 GetContainer を 実装すると、リンク クライアントはコンテナーのオブジェクトを列挙し、包含階層を再帰的に走査できます。 このメソッドは省略可能ですが、埋め込みオブジェクトへのリンクをサポートすることを想定しているすべてのコンテナーに推奨されます。

リンク クライアントは、GetContainer を再帰的に呼び出してリンク ソースのコンテナーへのポインターを取得することで、複合ドキュメント オブジェクトの階層を走査できます。コンテナーの IOleObject インターフェイスへのポインターを取得するには QueryInterface が続き、最後に IOleObject::GetClientSite を使用してコンテナー内のコンテナーのクライアント サイトを取得します。

埋め込みオブジェクトへのリンクをサポートしていない単純なコンテナーでは、おそらくこのメソッドを実装する必要はありません。 代わりに、E_NOINTERFACEを返し、 ppContainer を NULL に設定できます。

要件

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

こちらもご覧ください

IOleClientSite