ITransferSource::Advise メソッド (shobjidl_core.h)

  • [アーティクル]

ファイル操作の状態に関する通知のアドバイザリ接続を設定します。

構文

HRESULT Advise(
  [in]  ITransferAdviseSink *psink,
  [out] DWORD               *pdwCookie
);

パラメーター

[in] psink

種類: ITransferAdviseSink*

このインターフェイスのメソッドを使用して呼び出し元のアプリケーションを更新するための通知インターフェイス ITransferAdviseSink へのポインター。

[out] pdwCookie

種類: DWORD*

この接続を一意に識別する、返されたトークンへのポインター。 呼び出し元のアプリケーションでは、後でこのトークンを使用して、 ITransferSource::Unadvise メソッドに渡すことで接続を削除します。 接続が正常に確立されなかった場合、この値は 0 です。

戻り値

種類: HRESULT

一覧に記載されていない HRESULT は、エラーを示します。

リターン コード 説明
S_OK
 インターフェイスが正常に関連付けられています。
E_UNEXPECTED
 ハンドラーは、1 つのシンク インターフェイスのみを処理できます。

解説

アドバイザリ セッションを有効にするには、このインターフェイスで他のメソッドを呼び出す前に ITransferSource::Advise を呼び出します。 設定されていない場合、ハンドラーは、フィードバックが利用できないことを示し、呼び出し元のアプリケーションに相談せずに "既定" 操作を実行することを示すものと見なす必要があります。

要件

   
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shobjidl_core.h (Shobjidl.h を含む)