IBackgroundCopyJob::SetDescription-Methode (bits.h)

Stellt eine Beschreibung des Auftrags bereit.

Syntax

HRESULT SetDescription(
  [in] LPCWSTR Val
);

Parameter

[in] Val

Null-beendete Zeichenfolge, die zusätzliche Informationen zum Auftrag bereitstellt. Die Länge der Zeichenfolge ist auf 1.024 Zeichen beschränkt, ohne das NULL-Abschlusszeichen.

Rückgabewert

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

Rückgabecode	Beschreibung
S_OK	Beschreibung des Auftrags wurde erfolgreich festgelegt.
E_INVALIDARG	Der pDescription-Parameter darf nicht NULL sein.
BG_E_STRING_TOO_LONG	Die Beschreibung überschreitet 1.024 Zeichen.
BG_E_INVALID_STATE	Der Status des Auftrags kann nicht BG_JOB_STATE_CANCELLED oder BG_JOB_STATE_ACKNOWLEDGED werden.

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