IBackgroundCopyJob::SetNotifyFlags メソッド (bits.h)

ジョブ転送イベントなど、受信するイベント通知の種類を指定します。

構文

HRESULT SetNotifyFlags(
  [in] ULONG Val
);

パラメーター

[in] Val

次のフラグの 1 つ以上を設定して、受信するイベントを識別します。

意味
BG_NOTIFY_JOB_TRANSFERRED
0x0001
ジョブ内のすべてのファイルが転送されました。
BG_NOTIFY_JOB_ERROR
0x0002
問題が発生しました。
BG_NOTIFY_DISABLE
0x0004
イベント通知が無効になっています。 BITS は他のフラグを無視します。
BG_NOTIFY_JOB_MODIFICATION
0x0008
ジョブが変更されました。 たとえば、プロパティ値の変更、ジョブの状態の変更、ファイルの転送の進行状況などです。 コマンド ライン通知 が指定されている場合、コマンド ライン コールバックではこのフラグは無視されます。
BG_NOTIFY_FILE_TRANSFERRED
0x0010
ジョブ内のファイルが転送されました。 コマンド ライン通知 が指定されている場合、コマンド ライン コールバックではこのフラグは無視されます。
BG_NOTIFY_FILE_RANGES_TRANSFERRED
0x0020
ファイル内のバイト範囲が転送されました。 コマンド ライン通知 が指定されている場合、コマンド ライン コールバックではこのフラグは無視されます。 フラグは任意のジョブに対して指定できますが、通知を受け取るのは 、BITS_JOB_PROPERTY_ON_DEMAND_MODE ジョブの要件を満たすジョブのみです。

戻り値

このメソッドは、次の HRESULT 値と他の値を返します。

リターン コード 説明
S_OK
イベント通知の種類が正常に設定されました。
E_NOTIMPL
NotifyFlags 値が無効です。
BG_E_INVALID_STATE
ジョブの状態をBG_JOB_STATE_CANCELLEDまたはBG_JOB_STATE_ACKNOWLEDGEDすることはできません。

注釈

イベント通知を受信するには、IBackgroundCopyJob::SetNotifyInterface メソッドおよび IBackgroundCopyJob2::SetNotifyCmdLine メソッドと組み合わせて SetNotifyFlags メソッドを使用します。

IBackgroundCopyJob::SetNotifyInterface メソッドのコード例を参照してください。

要件

要件
サポートされている最小のクライアント Windows XP
サポートされている最小のサーバー Windows Server 2003
対象プラットフォーム Windows
ヘッダー bits.h
Library Bits.lib
[DLL] QmgrPrxy.dll

こちらもご覧ください

IBackgroundCopyCallback

IBackgroundCopyCallback2

IBackgroundCopyJob2::SetNotifyCmdLine

IBackgroundCopyJob::GetNotifyFlags

IBackgroundCopyJob::SetNotifyInterface