IBackgroundCopyJob::SetDisplayName-Methode (bits.h)

Gibt einen Anzeigenamen für den Auftrag an. In der Regel verwenden Sie den Anzeigenamen, um den Auftrag in einer Benutzeroberfläche zu identifizieren.

Syntax

HRESULT SetDisplayName(
  [in] LPCWSTR Val
);

Parameter

[in] Val

Null-beendete Zeichenfolge, die den Auftrag identifiziert. Darf nicht NULL sein. Die Länge der Zeichenfolge ist auf 256 Zeichen beschränkt, ohne den NULL-Abschluss.

Rückgabewert

Diese Methode gibt die folgenden HRESULT-Werte sowie andere zurück.

Rückgabecode	Beschreibung
S_OK	Anzeigename wurde erfolgreich festgelegt.
E_INVALIDARG	Der pDisplayName-Parameter darf nicht NULL sein, oder der Name überschreitet 256 Zeichen.
BG_E_STRING_TOO_LONG	Der Anzeigename überschreitet 256 Zeichen.
BG_E_INVALID_STATE	Der Status des Auftrags kann nicht BG_JOB_STATE_CANCELLED oder BG_JOB_STATE_ACKNOWLEDGED werden.

Hinweise

Der Anzeigename wird ursprünglich festgelegt, wenn Sie den Auftrag erstellen. Ausführliche Informationen zum Angeben des Anzeigenamens beim Erstellen des Auftrags finden Sie in der IBackgroundCopyManager::CreateJob-Methode .

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP
Unterstützte Mindestversion (Server)	Windows Server 2003
Zielplattform	Windows
Kopfzeile	bits.h
Bibliothek	Bits.lib
DLL	QmgrPrxy.dll

Weitere Informationen

IBackgroundCopyJob::GetDisplayName

IBackgroundCopyManager::CreateJob