IBackgroundCopyJob インターフェイス (bits.h)
IBackgroundCopyJob インターフェイスを使用して、ジョブにファイルを追加し、ジョブの優先度レベルを設定し、ジョブの状態を決定し、ジョブを開始および停止します。
ジョブを作成するには、 IBackgroundCopyManager::CreateJob メソッドを 呼び出します。 既存のジョブへの IBackgroundCopyJob インターフェイス ポインターを取得するには、 IBackgroundCopyManager::GetJob メソッドを呼び出します。
継承
IBackgroundCopyJob インターフェイスは、IUnknown インターフェイスから継承されます。 IBackgroundCopyJob には、次の種類のメンバーもあります。
メソッド
IBackgroundCopyJob インターフェイスには、これらのメソッドがあります。
| IBackgroundCopyJob::AddFile ジョブに 1 つのファイルを追加します。 |
| IBackgroundCopyJob::AddFileSet ジョブに複数のファイルを追加します。 |
| IBackgroundCopyJob::Cancel 転送キューからジョブを削除し、クライアント (ダウンロード) とサーバー (アップロード) から関連する一時ファイルを削除します。 |
| IBackgroundCopyJob::Complete ジョブを終了し、転送されたファイルをクライアントに保存します。 |
| IBackgroundCopyJob::EnumFiles ジョブ内のファイルを列挙するために使用する IEnumBackgroundCopyFiles インターフェイス ポインターを取得します。 |
| IBackgroundCopyJob::GetDescription ジョブの説明を取得します。 |
| IBackgroundCopyJob::GetDisplayName ジョブの表示名を取得します。 通常、表示名を使用して、ユーザー インターフェイスでジョブを識別します。 |
| IBackgroundCopyJob::GetError エラーが発生した後にエラー インターフェイスを取得します。 |
| IBackgroundCopyJob::GetErrorCount BITS がジョブの転送を試行し、エラーが発生した回数を取得します。 |
| IBackgroundCopyJob::GetId キュー内のジョブを識別するために使用される識別子を取得します。 |
| IBackgroundCopyJob::GetMinimumRetryDelay ファイルの転送を試みる前に、一時的なエラー状態が発生した後にサービスが待機する最小時間を取得します。 |
| IBackgroundCopyJob::GetNoProgressTimeout 一時的なエラー状態が発生した後にサービスがファイルの転送を試みる時間を取得します。 進行状況がある場合は、タイマーがリセットされます。 |
| IBackgroundCopyJob::GetNotifyFlags ジョブのイベント通知フラグを取得します。 |
| IBackgroundCopyJob::GetNotifyInterface IBackgroundCopyCallback インターフェイスの実装へのインターフェイス ポインターを取得します。 |
| IBackgroundCopyJob::GetOwner ジョブの所有者の ID を取得します。 |
| IBackgroundCopyJob::GetPriority ジョブの優先度レベルを取得します。 優先度レベルは、転送キュー内の他のジョブに対してジョブをいつ処理するかを決定します。 |
| IBackgroundCopyJob::GetProgress 転送されたバイト数やファイル数など、ジョブ関連の進行状況情報を取得します。 |
| IBackgroundCopyJob::GetProxySettings ジョブがファイルの転送に使用するプロキシ情報を取得します。 |
| IBackgroundCopyJob::GetState ジョブの状態を取得します。 |
| IBackgroundCopyJob::GetTimes ジョブが作成された時刻や最後に変更された時刻など、ジョブ関連のタイム スタンプを取得します。 |
| IBackgroundCopyJob::GetType ファイルのダウンロードやアップロードなど、実行される転送の種類を取得します。 |
| IBackgroundCopyJob::Resume 新しいジョブをアクティブ化するか、中断されたジョブを再起動します。 |
| IBackgroundCopyJob::SetDescription ジョブの説明を提供します。 |
| IBackgroundCopyJob::SetDisplayName ジョブの表示名を指定します。 通常、表示名を使用して、ユーザー インターフェイスでジョブを識別します。 |
| IBackgroundCopyJob::SetMinimumRetryDelay ファイルの転送を試みる前に、一時的なエラー状態が発生した後に BITS が待機する最小時間を設定します。 |
| IBackgroundCopyJob::SetNoProgressTimeout BITS が一時的なエラー状態が発生した後にファイルの転送を試みる時間を設定します。 進行状況がある場合は、タイマーがリセットされます。 |
| IBackgroundCopyJob::SetNotifyFlags ジョブ転送イベントなど、受信するイベント通知の種類を指定します。 |
| IBackgroundCopyJob::SetNotifyInterface BITS への IBackgroundCopyCallback インターフェイスの実装を識別します。 IBackgroundCopyCallback インターフェイスを使用して、ジョブ関連のイベントの通知を受け取ります。 |
| IBackgroundCopyJob::SetPriority ジョブの優先度レベルを指定します。 優先度レベルは、転送キュー内の他のジョブに対してジョブが処理されるタイミングを決定します。 |
| IBackgroundCopyJob::SetProxySettings ファイルの転送に使用するプロキシを指定します。 |
| IBackgroundCopyJob::Suspend ジョブを中断します。 新しいジョブ、エラーが発生しているジョブ、およびファイルの転送が完了したジョブは自動的に中断されます。 |
| IBackgroundCopyJob::TakeOwnership ジョブの所有権を現在のユーザーに変更します。 |
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP |
| サポートされている最小のサーバー | Windows Server 2003 |
| 対象プラットフォーム | Windows |
| ヘッダー | bits.h |