IBackgroundCopyJob::GetError メソッド

  • [アーティクル]

エラーが発生した後にエラー インターフェイスを取得します。

配信の最適化では、ジョブの状態がBG_JOB_STATE_ERRORまたはBG_JOB_STATE_TRANSIENT_ERRORされると、エラー オブジェクトが生成されます。 IBackgroundCopyXXXX インターフェイス メソッドの呼び出しが失敗しても、サービスはエラー オブジェクトを作成しません。 エラー オブジェクトは、配信の最適化がジョブのデータの転送を開始するまで (ジョブの状態がBG_JOB_STATE_TRANSFERRINGに変更されるまで)、またはアプリケーションが終了するまで使用できます。

構文

HRESULT GetError(
  [out] IBackgroundCopyError **ppError
);

パラメーター

ppError [out]

エラー コード、エラーの説明、およびエラーが発生したコンテキストを提供するエラー インターフェイス。 このパラメーターは、エラーが発生したときに転送されるファイルも識別します。 完了したら ppError を 解放します。

戻り値

このメソッドは、次の HRESULT 値だけでなく、他の値も返します。

リターン コード 説明
S_OK
 エラー オブジェクトが正常に生成されました。
DO_E_ERROR_INFORMATION_UNAVAILABLE
 エラー インターフェイスは、エラーが発生した後 (BG_JOB_STATE_ERRORまたはBG_JOB_STATE_TRANSIENT_ERROR)、配信の最適化がデータの転送を開始する前 (BG_JOB_STATE_TRANSFERRING) にのみ使用できます。

解説

ジョブは、致命的なエラー時にエラー状態になります。 ジョブがエラーになっているかどうかを判断するには、次のいずれかのオプションを使用します。

IBackgroundCopyError インターフェイスには、エラーの原因と転送プロセスを続行できるかどうかを判断するために使用する情報が含まれています。 エラーの原因を特定したら、次のいずれかのオプションを実行します。

要件

要件 値
サポートされている最小のクライアント
 Windows 10バージョン 1709 [デスクトップ アプリのみ]
サポートされている最小のサーバー
 Windows Server バージョン 1709 [デスクトップ アプリのみ]
ヘッダー
Deliveryoptimization.h
IDL
DeliveryOptimization.idl
ライブラリ
Dosvc.lib
[DLL]
Dosvc.dll
IID
 IID_IBackgroundCopyJobは 37668D37-507E-4160-9316-26306D150B12 と定義されています

関連項目

IBackgroundCopyJob

IBackgroundCopyCallback::JobError

IBackgroundCopyError

IBackgroundCopyJob::GetState