IScheduledWorkItem::SetIdleWait-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 .] ]

Legt die Minuten fest, in denen sich das System im Leerlauf befinden muss, bevor das Arbeitselement ausgeführt werden kann.

Syntax

HRESULT SetIdleWait(
  [in] WORD wIdleMinutes,
  [in] WORD wDeadlineMinutes
);

Parameter

[in] wIdleMinutes

Ein -Wert, der angibt, wie lange das System in Minuten im Leerlauf bleiben muss, bevor das Arbeitselement ausgeführt werden kann.

[in] wDeadlineMinutes

Ein -Wert, der die maximale Anzahl von Minuten angibt, die der Taskplaner auf den in pwIdleMinutes zurückgegebenen Leerlaufzeitraum wartet.

Rückgabewert

Die SetIdleWait-Methode gibt S_OK zurück.

Hinweise

Die hier angegebene Leerlaufzeit wird in Verbindung mit Leerlauftriggern und Leerlaufbedingungen verwendet. Weitere Informationen finden Sie unter Task-Leerlaufbedingungen. Leerlauftrigger sind ereignisbasierte Trigger, die keiner geplanten Zeit zugeordnet sind. Im Gegensatz dazu sind Leerlaufbedingungen der geplanten Startzeit für den Vorgang zugeordnet.

Sie geben Leerlauftrigger an, indem Sie den TASK_TRIGGER_TYPE Member des TASK_TRIGGER auf TASK_EVENT_TRIGGER_ON_IDLE festlegen. Der Leerlauftrigger wird ausgelöst, wenn das System für den von wIdleMinutes angegebenen Zeitraum in den Leerlauf wechselt.

Sie legen Leerlaufbedingungen fest, indem Sie IScheduledWorkItem::SetFlags aufrufen. Wenn das flag TASK_FLAG_START_ONLY_IF_IDLE festgelegt ist, wird das Arbeitselement nur dann zu dem geplanten Zeitpunkt ausgeführt, wenn das System für den von wIdleMinutes angegebenen Zeitraum in den Leerlauf wechselt. Der Taskplaner-Dienst wartet bis zu der in wDeadlineMinutes angegebenen Anzahl von Minuten nach der geplanten Startzeit, um zu ermitteln, ob das System in den Leerlauf wechselt.

Anwendungen müssen die IPersistFile::Save-Methode aufrufen, nachdem SetIdleWait aufgerufen wurde, um das Leerlaufwarteintervall zu aktualisieren.

Beispiele

Ein Beispiel zum Festlegen der Leerlaufzeit beim Erstellen eines Leerlauftriggers finden Sie unter Erstellen eines Leerlauftriggers.

Anforderungen

Weitere Informationen

IScheduledWorkItem

IScheduledWorkItem::GetIdleWait