Share via


IBackgroundCopyJob ::SetDescription, méthode (bits.h)

Fournit une description du travail.

Syntaxe

HRESULT SetDescription(
  [in] LPCWSTR Val
);

Paramètres

[in] Val

Chaîne terminée par null qui fournit des informations supplémentaires sur le travail. La longueur de la chaîne est limitée à 1 024 caractères, à l’exception de la marque de fin Null.

Valeur retournée

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

Code de retour Description
S_OK
La description du travail a été correctement définie.
E_INVALIDARG
Le paramètre pDescription ne peut pas être NULL.
BG_E_STRING_TOO_LONG
La description dépasse 1 024 caractères.
BG_E_INVALID_STATE
L’état du travail ne peut pas être BG_JOB_STATE_CANCELLED ou BG_JOB_STATE_ACKNOWLEDGED.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows XP
Serveur minimal pris en charge Windows Server 2003
Plateforme cible Windows
En-tête bits.h
Bibliothèque Bits.lib
DLL QmgrPrxy.dll

Voir aussi

IBackgroundCopyJob ::GetDescription