Método IScheduledWorkItem::GetIdleWait (mstask.h)
[[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. ]
Recupera el tiempo de espera de inactividad del elemento de trabajo.
Para obtener información sobre las condiciones de inactividad, vea Condiciones de inactividad de tareas.
Sintaxis
HRESULT GetIdleWait(
[out] WORD *pwIdleMinutes,
[out] WORD *pwDeadlineMinutes
);
Parámetros
[out] pwIdleMinutes
Puntero a una PALABRA que contiene el tiempo de espera de inactividad del elemento de trabajo actual, en minutos.
[out] pwDeadlineMinutes
Puntero a un WORD que especifica el número máximo de minutos que el Programador de tareas esperará al período de inactividad devuelto en pwIdleMinutes.
Valor devuelto
El método GetIdleWait devuelve uno de los valores siguientes.
| Código devuelto | Descripción |
|---|---|
|
La operación se realizó correctamente. |
|
Los argumentos no son válidos. |
Comentarios
El tiempo de inactividad devuelto aquí se usa junto con desencadenadores inactivos y condiciones de inactividad. Los desencadenadores inactivos son desencadenadores basados en eventos que no están asociados a una hora programada. Las condiciones de inactividad están asociadas a la hora de inicio programada para la tarea.
Los desencadenadores inactivos se especifican estableciendo el miembro TASK_TRIGGER_TYPE de la estructura TASK_TRIGGER en el valor TASK_EVENT_TRIGGER_ON_IDLE. El desencadenador inactivo se desencadena cuando el sistema pasa a estar inactivo durante la cantidad de tiempo devuelto en pwIdleMinutes.
Puede establecer condiciones de inactividad llamando 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 la cantidad de tiempo devuelto en pwIdleMinutes. El servicio Programador de tareas esperará hasta pwDeadlineMinutes después de la hora de inicio programada para ver si el sistema deja de estar inactivo.
Ejemplos
Para obtener un ejemplo de cómo recuperar el tiempo de espera de inactividad de una tarea, vea Ejemplo de código de C/C++: Recuperación del tiempo de espera de inactividad de la tarea.
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 |