ホーム › System.Ole › IOleContainer

IOleContainer

COM

📘 Microsoft Learn (日本語) · English

IID0000011b-0000-0000-c000-000000000046継承元IParseDisplayName自前メソッド開始 vtbl4

公式ドキュメント

複合ドキュメント内のオブジェクトを列挙する、またはコンテナーを実行状態でロックします。コンテナーアプリケーションとオブジェクトアプリケーションの両方がこのインターフェイスを実装します。

メソッド 2

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

vtbl 4 HRESULT EnumObjects(DWORD grfFlags, IEnumUnknown** ppenum)

現在のコンテナー内のオブジェクトを列挙します。

grfFlags	DWORD	in	コンテナー内のどのオブジェクトを列挙するかを、列挙型 OLECONTF で定義されているとおりに指定します。
ppenum	IEnumUnknown**	out	列挙子オブジェクトへのインターフェイスポインターを受け取る IEnumUnknown ポインター変数へのポインターです。コンテナーは EnumObjects の呼び出しが成功するたびに、このメソッドが返す ppenum ポインターの参照カウントを増やす必要があります。ポインターの使用が終わったら IUnknown::Release を呼び出すのは呼び出し元の責任です。エラーが返される場合、実装は ppenum を NULL に設定する必要があります。

戻り値

このメソッドは成功時に S_OK を返します。その他の戻り値には次のものがあります。

戻りコード	説明
E_FAIL	操作が失敗しました。
E_NOTIMPL	オブジェクトの列挙はサポートされていません。

解説(Remarks)

コンテナーは、プログラムによるクライアントが保持しているオブジェクトを把握できるようにするために EnumObjects を実装する必要があります。ただし、このメソッドは標準的なリンクのシナリオでは呼び出されません。

vtbl 5 HRESULT LockContainer(BOOL fLock)

埋め込みオブジェクトのコンテナーを、明示的に解放されるまで実行状態のまま維持します。

fLock

BOOL

コンテナーをロック (TRUE) するかロック解除 (FALSE) するかを示します。

戻り値

このメソッドは成功時に S_OK を返します。その他の戻り値には次のものがあります。

戻りコード	説明
E_FAIL	操作が失敗しました。
E_OUTOFMEMORY	操作に使用できるメモリが不足しています。

解説(Remarks)

埋め込みオブジェクトは、更新を必要とするリンククライアントを持つ場合に、そのコンテナーを実行状態に保つために LockContainer を呼び出します。ただし、エンドユーザーがコンテナーのメニューから [ファイル] の [閉じる] を選択した場合、コンテナーは未処理の LockContainer ロックをすべて無視し、いずれにせよドキュメントを閉じます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IOleContainer "{0000011B-0000-0000-C000-000000000046}"
#usecom global IOleContainer IID_IOleContainer "{}"
#comfunc global IOleContainer_EnumObjects    4 int,sptr
#comfunc global IOleContainer_LockContainer  5 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。