Método IScheduledWorkItem::SetIdleWait (mstask.h)

  • Artículo

[[Esta API puede modificarse o no estar disponible en versiones posteriores del sistema operativo o del producto. Use las interfaces del Programador de tareas 2.0 en su lugar. ]

Establece los minutos que el sistema debe estar inactivo antes de que se pueda ejecutar el elemento de trabajo .

Sintaxis

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

Parámetros

[in] wIdleMinutes

Valor que especifica cuánto tiempo, en minutos, el sistema debe permanecer inactivo antes de que se pueda ejecutar el elemento de trabajo.

[in] wDeadlineMinutes

Valor que especifica el número máximo de minutos que el Programador de tareas esperará durante el período de inactividad devuelto en pwIdleMinutes.

Valor devuelto

El método SetIdleWait devuelve S_OK.

Comentarios

El tiempo de inactividad especificado aquí se usa junto con desencadenadores inactivos y condiciones de inactividad. Para obtener más información, vea Condiciones de inactividad de tareas. Los desencadenadores inactivos son desencadenadores basados en eventos que no están asociados a una hora programada. Las condiciones de inactividad, en cambio, están asociadas a la hora de inicio programada para la tarea.

Para especificar desencadenadores inactivos, establezca el miembro TASK_TRIGGER_TYPE del TASK_TRIGGER en TASK_EVENT_TRIGGER_ON_IDLE. El desencadenador inactivo se desencadena cuando el sistema pasa a estar inactivo durante el tiempo especificado por wIdleMinutes.

Para establecer condiciones de inactividad, llame a IScheduledWorkItem::SetFlags. Si se establece la marca de TASK_FLAG_START_ONLY_IF_IDLE, el elemento de trabajo se ejecuta a su hora programada solo si el sistema deja de estar inactivo durante el tiempo especificado por wIdleMinutes. El servicio Programador de tareas esperará hasta el número de minutos especificados en wDeadlineMinutes después de la hora de inicio programada para ver si el sistema deja de estar inactivo.

Las aplicaciones deben llamar al método IPersistFile::Save después de llamar a SetIdleWait para actualizar el intervalo de espera inactivo.

Ejemplos

Para obtener un ejemplo de cómo establecer el tiempo de espera de inactividad al crear un desencadenador inactivo, consulte El ejemplo de creación de un desencadenador inactivo.

Requisitos

Requisito Value
Cliente mínimo compatible Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado mstask.h
Library Mstask.lib
Archivo DLL Mstask.dll
Redistribuible Internet Explorer 4.0 o posterior en Windows NT 4.0 y Windows 95

Consulte también

IScheduledWorkItem

IScheduledWorkItem::GetIdleWait