Méthode IBackgroundCopyJob::GetError

Article
06/12/2023

Récupère l’interface d’erreur après qu’une erreur s’est produite.

L’optimisation de la distribution génère un objet d’erreur lorsque l’état du travail est BG_JOB_STATE_ERROR ou BG_JOB_STATE_TRANSIENT_ERROR. Le service ne crée pas d’objet d’erreur lorsqu’un appel à une méthode d’interface IBackgroundCopyXXXXxx échoue. L’objet d’erreur est disponible jusqu’à ce que l’optimisation de la distribution commence à transférer les données (l’état du travail passe à BG_JOB_STATE_TRANSFERRING) pour le travail ou jusqu’à ce que votre application se termine.

Syntaxe

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

Paramètres

ppError [out]: Interface d’erreur qui fournit le code d’erreur, une description de l’erreur et le contexte dans lequel l’erreur s’est produite. Ce paramètre identifie également le fichier en cours de transfert au moment où l’erreur s’est produite. Relâchez ppError lorsque vous avez terminé.

Valeur retournée

Cette méthode retourne les valeurs HRESULT suivantes, ainsi que d’autres.

Code de retour	Description
S_OK	L’objet d’erreur a été correctement généré.
DO_E_ERROR_INFORMATION_UNAVAILABLE	L’interface d’erreur n’est disponible qu’après qu’une erreur s’est produite (BG_JOB_STATE_ERROR ou BG_JOB_STATE_TRANSIENT_ERROR) et avant que l’optimisation de la distribution commence le transfert des données (BG_JOB_STATE_TRANSFERRING).

Notes

Le travail est placé dans un état d’erreur en cas d’erreurs irrécupérables. Utilisez l’une des options suivantes pour déterminer si le travail est en erreur :

Pour interroger l’état du travail, appelez la méthode IBackgroundCopyJob::GetState . Le travail est en erreur si l’état est BG_JOB_STATE_ERROR.
Pour recevoir une notification en cas d’erreur, implémentez l’interface IBackgroundCopyCallback (en particulier, la méthode JobError ). Ensuite, appelez la méthode IBackgroundCopyJob::SetNotifyInterface pour inscrire le rappel et la méthode IBackgroundCopyJob::SetNotifyFlags pour définir l’indicateur BG_NOTIFY_JOB_ERROR.

L’interface IBackgroundCopyError contient des informations que vous utilisez pour déterminer la cause de l’erreur et si le processus de transfert peut se poursuivre. Une fois que vous avez déterminé la cause de l’erreur, effectuez l’une des options suivantes :

Pour annuler le travail, appelez la méthode IBackgroundCopyJob::Cancel .
Pour enregistrer les fichiers qui ont été transférés correctement avant que l’erreur ne se produise, appelez la méthode IBackgroundCopyJob::Complete .
Pour terminer le traitement du travail, corrigez le problème, puis appelez la méthode IBackgroundCopyJob::Resume .

Spécifications

Condition requise	Valeur
Client minimal pris en charge	Windows 10, version 1709 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server, version 1709 [applications de bureau uniquement]
En-tête	Deliveryoptimization.h
IDL	DeliveryOptimization.idl
Bibliothèque	Dosvc.lib
DLL	Dosvc.dll
IID	IID_IBackgroundCopyJob est défini comme 37668D37-507E-4160-9316-26306D150B12

Voir aussi

IBackgroundCopyJob
IBackgroundCopyCallback::JobError
IBackgroundCopyError
IBackgroundCopyJob::GetState