IScheduledWorkItem::GetIdleWait-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 Leerlaufzeit für das Arbeitselement ab.
Weitere Informationen zu Leerlaufbedingungen finden Sie unter Task-Leerlaufbedingungen.
Syntax
HRESULT GetIdleWait(
[out] WORD *pwIdleMinutes,
[out] WORD *pwDeadlineMinutes
);
Parameter
[out] pwIdleMinutes
Ein Zeiger auf ein WORD , das die Leerlaufzeit für das aktuelle Arbeitselement in Minuten enthält.
[out] pwDeadlineMinutes
Ein Zeiger auf ein WORD , der die maximale Anzahl von Minuten angibt, für die der Taskplaner auf den in pwIdleMinutes zurückgegebenen Leerlaufzeitraum wartet.
Rückgabewert
Die GetIdleWait-Methode gibt einen der folgenden Werte zurück.
| Rückgabecode | BESCHREIBUNG |
|---|---|
|
Der Vorgang wurde durchgeführt. |
|
Die Argumente sind ungültig. |
Hinweise
Die hier zurückgegebene Leerlaufzeit wird in Verbindung mit Leerlauftriggern und Leerlaufbedingungen verwendet. Leerlauftrigger sind ereignisbasierte Trigger, die keiner geplanten Zeit zugeordnet sind. Leerlaufbedingungen sind der geplanten Startzeit für den Vorgang zugeordnet.
Leerlauftrigger werden durch Festlegen des TASK_TRIGGER_TYPE-Elements der TASK_TRIGGER-Struktur auf den Wert TASK_EVENT_TRIGGER_ON_IDLE angegeben. Der Leerlauftrigger wird ausgelöst, wenn das System für die in pwIdleMinutes zurückgegebene Zeit in den Leerlauf wechselt.
Sie können Leerlaufbedingungen festlegen, indem Sie IScheduledWorkItem::SetFlags aufrufen. Wenn das flag TASK_FLAG_START_ONLY_IF_IDLE festgelegt ist, wird das Arbeitselement nur dann zu seinem geplanten Zeitpunkt ausgeführt, wenn das System für die in pwIdleMinutes zurückgegebene Zeit in den Leerlauf wechselt. Der Taskplaner-Dienst wartet bis zu pwDeadlineMinutes nach der geplanten Startzeit, um zu sehen, ob das System in den Leerlauf wechselt.
Beispiele
Ein Beispiel zum Abrufen der Leerlaufzeit einer Aufgabe finden Sie unter C/C++-Codebeispiel: Abrufen der Leerlaufzeit des Tasks.
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 |