IOleInPlaceUIWindow::SetActiveObject メソッド (oleidl.h)

[アーティクル]
03/01/2024

オブジェクトと各フレームウィンドウとドキュメントウィンドウの間の直接の通信チャネルを提供します。

構文

HRESULT SetActiveObject(
  [in] IOleInPlaceActiveObject *pActiveObject,
  [in] LPCOLESTR               pszObjName
);

パラメーター

[in] pActiveObject

アクティブなインプレースオブジェクトの IOleInPlaceActiveObject インターフェイスへのポインター。

[in] pszObjName

埋め込みコンテナーがウィンドウタイトルの作成に使用できるオブジェクトを記述する名前を含む文字列へのポインター。オブジェクトがウィンドウタイトルを変更するためにコンテナーを必要としない場合は NULL にすることができます 。コンテナーは、このパラメーターを無視し、タイトルバーで常に独自の名前を使用する必要があります。

戻り値

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

リターンコード	説明
E_UNEXPECTED	予期しないエラーが発生しました。

注釈

通常、埋め込みオブジェクトは pszObjName パラメーターに NULL を渡す必要があります (下記の「実装者へのメモ」を参照してください)。ただし、そのタイトルバーにインプレースアクティブオブジェクトの名前を表示するコンテナーと組み合わせて作業している場合は、アプリケーション名 – <オブジェクトの短縮型名>>という形式<で文字列を作成する必要があります。

呼び出し元へのメモ

IOleInPlaceUIWindow::SetActiveObject は、 オブジェクトによって呼び出され、それ自体とドキュメントウィンドウとフレームウィンドウ間の直接通信リンクを確立します。

非アクティブ化すると、オブジェクトは IOleInPlaceUIWindow::SetActiveObject を呼び出し、pActiveObject パラメーターと pszObjName パラメーターに NULL を渡します。

オブジェクトは 、IOleInPlaceFrame::SetMenu を呼び出す前に IOleInPlaceUIWindow::SetActiveObject を呼び出して、コンテナーにアクティブオブジェクトへのポインターを与える必要があります。その後、コンテナーは IOleInPlaceFrame::SetMenu の処理でこのポインターを使用し、 OleSetMenuDescriptor に渡します。

実装者へのメモ

Microsoft Windows ユーザーインターフェイスデザインガイドでは、このメソッドで渡された pszObjName パラメーターをインプレースコンテナーで無視することをお勧めします。ガイドには、「タイトルバーはインプレースアクティブ化の影響を受けません。常に最上位レベルのコンテナーの名前が表示されます。

要件

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

こちらもご覧ください

IOleInPlaceFrame::SetMenu

IOleInPlaceUIWindow

OleSetMenuDescriptor