IObjectWithCancelEvent::GetCancelEvent メソッド (shobjidl_core.h)

操作が取り消されたときに送信されるイベントを取得します。

構文

HRESULT GetCancelEvent(
  [out] HANDLE *phEvent
);

パラメーター

[out] phEvent

種類: HANDLE*

このメソッドが正常に返されるときに、キャンセル イベントのハンドルであるハンドルへのポインター。 呼び出し元は、不要になったときにこのハンドルを閉じる役割を担います。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

解説

呼び出されたオブジェクトが実行している操作を取り消したときに通知されるイベントを取得するには、この関数を呼び出します。 呼び出し元は、返されたハンドルを閉じる役割を担います。

要件

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

関連項目

IObjectWithCancelEvent