IOleAdviseHolder::EnumAdvise メソッド (oleidl.h)

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

オブジェクトに対して現在確立されているアドバイザリ接続を列挙するために使用できる列挙子を作成します。

構文

HRESULT EnumAdvise(
  [out] IEnumSTATDATA **ppenumAdvise
);

パラメーター

[out] ppenumAdvise

新しい列挙子へのインターフェイスポインターを受け取る IEnumSTATDATA ポインター変数へのポインター。このパラメーターが NULL の場合、オブジェクトにアドバイザリ接続が存在しないか、エラーが発生しました。アドバイス所有者は、このメソッドが提供する IEnumSTATDATA ポインターの参照カウントをインクリメントする役割を担います。ポインターが終了したら、IUnknown::Release を呼び出す必要があります。

戻り値

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

リターンコード	説明
E_FAIL	列挙操作が失敗しました。
E_NOTIMPL	IOleAdviseHolder::EnumAdvise は実装されていません。

注釈

IOleAdviseHolder::EnumAdvise は、オブジェクトの確立されたアドバイザリ接続を列挙するために使用できる列挙子を作成します。メソッドは、この列挙子の IEnumSTATDATA インターフェイスへのポインターを提供します。各接続のアドバイザリ接続情報は STATDATA 構造体に格納され、列挙子はこれらの構造体を列挙できる必要があります。

このメソッドでは、関連する構造体メンバーは pAdvise と dwConnection だけです。他のメンバーには、データアドバイザリ情報が含まれています。列挙メソッドを呼び出し、列挙の進行中に、列挙対象に対するアドバイザリ接続を登録または取り消す効果は未定義です。

要件

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