Freigeben über


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
);

Die Parameter

[in] Val

Null-beendete Zeichenfolge, die den Auftrag identifiziert. Darf nicht NULL sein. Die Länge der Zeichenfolge ist auf 256 Zeichen begrenzt, nicht einschließlich des Null-Terminators.

Rückgabewert

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

Rückgabecode Description
S_OK
Der Anzeigename wurde erfolgreich festgelegt.
E_INVALIDARG
Der Parameter "pDisplayName " 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.

Bemerkungen

Der Anzeigename wird beim Erstellen des Auftrags ursprünglich festgelegt. Ausführliche Informationen zum Angeben des Anzeigenamens beim Erstellen des Auftrags finden Sie unter der IBackgroundCopyManager::CreateJob-Methode .

Anforderungen

Anforderung Wert
Mindestens unterstützter Client Windows XP
Mindestanforderungen für unterstützte Server Windows Server 2003
Zielplattform Fenster
Header bits.h
Library Bits.lib
DLL QmgrPrxy.dll

Siehe auch

IBackgroundCopyJob::GetDisplayName

IBackgroundCopyManager::CreateJob