Función SetThreadpoolWait (threadpoolapiset.h)

Artículo
03/13/2024

Establece el objeto wait, reemplazando el objeto wait anterior, si existe. Un subproceso de trabajo llama a la función de devolución de llamada del objeto de espera después de que el identificador se señale o después de que expire el tiempo de espera especificado.

Sintaxis

void SetThreadpoolWait(
  [in, out]      PTP_WAIT  pwa,
  [in, optional] HANDLE    h,
  [in, optional] PFILETIME pftTimeout
);

Parámetros

[in, out] pwa

Puntero a una estructura TP_WAIT que define el objeto wait. La función CreateThreadpoolWait devuelve este puntero.

[in, optional] h

Un identificador.

Si este parámetro es NULL, el objeto wait dejará de poner en cola nuevas devoluciones de llamada (pero las devoluciones de llamada ya en cola se seguirán produciendo).

Si este parámetro no es NULL, debe hacer referencia a un objeto esperable válido.

Si se cierra este identificador mientras la espera sigue pendiente, el comportamiento de la función no está definido. Si la espera sigue pendiente y el identificador debe cerrarse, use CloseThreadpoolWait para cancelar la espera y, a continuación, cierre el identificador.

La espera se considera establecida si este parámetro no es NULL.

[in, optional] pftTimeout

Puntero a una estructura FILETIME que especifica el tiempo absoluto o relativo en el que la operación de espera debe agotar el tiempo de espera. Si este parámetro apunta a un valor positivo, indica la hora absoluta desde el 1 de enero de 1601 (UTC), en intervalos de 100 nanosegundos. Si este parámetro apunta a un valor negativo, indica la cantidad de tiempo de espera en relación con la hora actual. Para obtener más información sobre los valores de hora, vea Tiempos de archivo.

Si este parámetro apunta a 0, se agota el tiempo de espera inmediatamente. Si este parámetro es NULL, la espera no agotará el tiempo de espera.

Valor devuelto

None

Observaciones

Un objeto wait puede esperar solo un identificador. Si se establece el identificador de un objeto wait, se reemplaza el identificador anterior, si existe.

Debe volver a registrar el evento con el objeto wait antes de indicarlo cada vez que desencadene la devolución de llamada de espera.

Para compilar una aplicación que usa esta función, defina _WIN32_WINNT como 0x0600 o superior.

Ejemplos

Para obtener un ejemplo, vea Uso de las funciones del grupo de subprocesos.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [aplicaciones de escritorio \| aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 [aplicaciones de escritorio \| aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	threadpoolapiset.h (incluya Windows.h en Windows 7, Windows Server 2008 Windows Server 2008 R2)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll