Freigeben über


IBackgroundCopyJob::GetState-Methode (bits.h)

Ruft den Status des Auftrags ab.

Syntax

HRESULT GetState(
  [out] BG_JOB_STATE *pVal
);

Parameter

[out] pVal

Der Status des Auftrags. Der Status gibt beispielsweise an, ob der Auftrag fehlerhaft ist, Daten übertragen oder angehalten ist. Eine Liste der Auftragszustände finden Sie in der BG_JOB_STATE-Enumeration .

Rückgabewert

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

Rückgabecode Beschreibung
S_OK
Der Status des Auftrags wurde erfolgreich abgerufen.
E_INVALIDARG
Der Parameter pJobState darf nicht NULL sein.

Hinweise

Wenn Sie wissen möchten, wann ein Auftrag fehlerhaft ist oder alle Dateien im Auftrag übertragen wurden, können Sie diese Methode verwenden, um den Status des Auftrags abzufragen, oder Sie können sich registrieren, um Benachrichtigungen zu erhalten, wenn Ereignisse auftreten. Ausführliche Informationen zur Registrierung zum Empfangen von Ereignisbenachrichtigungen finden Sie unter der IBackgroundCopyCallback-Schnittstelle .

Beispiele

Sehen Sie sich den Beispielcode für die IBackgroundCopyManager::GetJob-Methode an.

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

BG_JOB_STATE, Ermitteln der status eines Auftrags, IBackgroundCopyCallback