IScheduledWorkItem::GetStatus-Methode (mstask.h)

[[Diese API kann in nachfolgenden Versionen des Betriebssystems oder Produkts geändert oder nicht verfügbar sein. Verwenden Sie stattdessen die Taskplaner 2.0-Schnittstellen .] ]

Ruft die status des Arbeitselements ab.

Syntax

HRESULT GetStatus(
  [out] HRESULT *phrStatus
);

Parameter

[out] phrStatus

Ein Zeiger auf einen HRESULT-Wert , der bei der Rückgabe einen der folgenden Werte enthält.

SCHED_S_TASK_READY

Das Arbeitselement kann zum nächsten geplanten Zeitpunkt ausgeführt werden.

SCHED_S_TASK_RUNNING

Das Arbeitselement wird derzeit ausgeführt.

SCHED_S_TASK_NOT_SCHEDULED

Mindestens eine der Eigenschaften, die zum Ausführen dieser Aufgabe nach einem Zeitplan erforderlich sind, wurde nicht festgelegt.

SCHED_S_TASK_HAS_NOT_RUN

Der Task wurde nicht ausgeführt. Dieser Wert wird zurückgegeben, wenn der Task nicht ausgeführt wurde, auch wenn der Vorgang zum nächsten geplanten Zeitpunkt ausgeführt werden kann oder es sich um einen wiederkehrenden Vorgang handelt.

SCHED_S_TASK_DISABLED

Der Task wird nicht zu den geplanten Zeiten ausgeführt, da er deaktiviert wurde.

SCHED_S_TASK_NO_MORE_RUNS

Für diesen Task sind keine weiteren Ausführungen geplant.

SCHED_S_TASK_NO_VALID_TRIGGERS

Der Task verfügt entweder über keine Trigger, oder die vorhandenen Trigger sind deaktiviert oder nicht festgelegt.

Rückgabewert

Die GetStatus-Methode gibt einen der folgenden Werte zurück.

Rückgabecode BESCHREIBUNG
S_OK
Der Vorgang wurde durchgeführt. Die Anforderung wurde gesendet. Weitere Informationen finden Sie in den Hinweisen.
E_INVALIDARG
Die Argumente sind ungültig.

Hinweise

Die Methoden der IScheduledWorkItem-Schnittstelle werden von der ITask-Schnittstelle geerbt. Daher wird IScheduledWorkItem::GetStatus in der Regel über die ITask-Schnittstelle aufgerufen.

IScheduledWorkItem::GetStatus ruft die status der Aufgabe nicht dynamisch ab. ITaskScheduler::Activate sollte aufgerufen werden, um eine neue IScheduledWorkItem-Schnittstelle zu erhalten, die zum Abrufen einer aktualisierten status verwendet wird. Weitere Informationen finden Sie im Beispiel für ITaskScheduler::Activate.

Beispiele

Ein Beispiel zum Abrufen der status einer Aufgabe finden Sie unter C/C++-Codebeispiel: Abrufen des Vorgangsstatus.

Ein Beispiel für das Abrufen der status als Teil des Beendens des Vorgangs finden Sie unter Beispiel zum Beenden eines Vorgangs.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile mstask.h
Bibliothek Mstask.lib
DLL Mstask.dll
Verteilbare Komponente Internet Explorer 4.0 oder höher unter Windows NT 4.0 und Windows 95

Weitere Informationen

IScheduledWorkItem

Itask