Méthode IBackgroundCopyJob ::SetDisplayName (bits.h)

Spécifie un nom d’affichage pour le travail. En règle générale, vous utilisez le nom d’affichage pour identifier le travail dans une interface utilisateur.

Syntaxe

HRESULT SetDisplayName(
  [in] LPCWSTR Val
);

Paramètres

[in] Val

Chaîne terminée par null qui identifie le travail. Ne doit pas avoir la valeur NULL. La longueur de la chaîne est limitée à 256 caractères, sans compter la fin null.

Valeur retournée

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

Code de retour	Description
S_OK	Le nom d’affichage a été correctement défini.
E_INVALIDARG	Le paramètre pDisplayName ne peut pas être NULL ou le nom dépasse 256 caractères.
BG_E_STRING_TOO_LONG	Le nom d’affichage dépasse 256 caractères.
BG_E_INVALID_STATE	L’état du travail ne peut pas être BG_JOB_STATE_CANCELLED ou BG_JOB_STATE_ACKNOWLEDGED.

Remarques

Le nom d’affichage est défini à l’origine lorsque vous créez le travail. Pour plus d’informations sur la spécification du nom d’affichage lors de la création du travail, consultez la méthode IBackgroundCopyManager ::CreateJob .

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 ::GetDisplayName

IBackgroundCopyManager ::CreateJob