Partager via


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

Spécifie un nom complet pour le travail. En règle générale, vous utilisez le nom complet 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 être NULL. La longueur de la chaîne est limitée à 256 caractères, sans inclure le terminateur Null.

Valeur retournée

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

Code de retour Descriptif
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 complet 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 complet est initialement défini lorsque vous créez le travail. Pour plus d’informations sur la spécification du nom complet lorsque vous créez le travail, consultez la méthode IBackgroundCopyManager ::CreateJob .

Spécifications

Requirement Valeur
Client minimum requis Windows XP
Serveur minimal pris en charge Windows Server 2003
plateforme cible Fenêtres
Header bits.h
Library Bits.lib
DLL QmgrPrxy.dll

Voir aussi

IBackgroundCopyJob ::GetDisplayName

IBackgroundCopyManager ::CreateJob