IBackgroundCopyJob インターフェイス
IBackgroundCopyJob インターフェイスを使用して、ジョブにファイルを追加し、ジョブの優先度レベルを設定し、ジョブの状態を決定し、ジョブを開始および停止します。
ジョブを作成するには、 IBackgroundCopyManager::CreateJob メソッドを 呼び出します。 既存のジョブへの IBackgroundCopyJob インターフェイス ポインターを取得するには、 IBackgroundCopyManager::GetJob メソッドを呼び出します。
メンバー
IBackgroundCopyJob インターフェイスは、IUnknown インターフェイスから継承されます。 IBackgroundCopyJob には、次の種類のメンバーもあります。
メソッド
IBackgroundCopyJob インターフェイスには、これらのメソッドがあります。
| メソッド | 説明 |
|---|---|
| キャンセル | ジョブを取り消し、クライアントから一時ファイルを削除します。 |
| 完了 | ジョブを終了し、転送されたファイルをクライアントに保存します。 |
| EnumFiles | ジョブ内のファイルを列挙するために使用する列挙子オブジェクトへのインターフェイス ポインターを返します。 |
| GetDisplayName | ジョブを識別する表示名を取得します。 |
| GetError | エラーが発生した後、エラー オブジェクトへのインターフェイス ポインターを取得します。 |
| GetId | キュー内のジョブの識別子を取得します。 |
| GetNoProgressTimeout | 一時的なエラー状態が発生した後も配信の最適化がファイルの転送を試み続ける時間の長さを取得します。 |
| GetNotifyFlags | アプリケーションに設定したイベント通知 (コールバック) フラグを取得します。 |
| GetNotifyInterface |
IBackgroundCopyCallback インターフェイス (コールバック) の実装へのポインターを取得します。 |
| GetPriority | ジョブに設定した優先度レベルを取得します。 |
| GetProgress | クライアントに転送されたバイト数やファイル数など、ジョブ関連の進行状況情報を取得します。 |
| GetState | ジョブの状態を取得します。 |
| GetTimes | ジョブが作成された時刻など、ジョブに関連するアクティビティのタイム スタンプを取得します。 |
| Gettype | ファイルのダウンロードなど、実行されている転送の種類を取得します。 |
| 再開 | 新しいジョブを開始するか、中断されたジョブを再起動します。 |
| SetNoProgressTimeout | 配信の最適化が一時的なエラー状態が発生した後にファイルの転送を試み続ける時間の長さを指定します。 |
| SetNotifyFlags | 受信するイベント通知の種類を指定します。 |
| SetNotifyInterface |
IBackgroundCopyCallback インターフェイス (コールバック) の実装へのポインターを指定します。 インターフェイスは、設定したイベント通知フラグに基づいて通知を受け取ります。 |
| SetPriority | 転送キュー内の他のジョブに対する相対的なジョブの優先順位を指定します。 |
| 中断 | ジョブを一時停止します。 |
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows 10、バージョン 1709 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows Server バージョン 1709 [デスクトップ アプリのみ] |
| ヘッダー |
|
| IDL |
|
| ライブラリ |
|
| [DLL] |
|
| IID |
IID_IBackgroundCopyJobは 37668D37-507E-4160-9316-26306D150B12 として定義されています |