Expand Minimize

SetThreadpoolWait function

Sets the wait object. A worker thread calls the wait object's callback function after the handle becomes signaled or after the specified timeout expires.

Syntax


VOID WINAPI SetThreadpoolWait(
  _Inout_   PTP_WAIT pwa,
  _In_opt_  HANDLE h,
  _In_opt_  PFILETIME pftTimeout
);

Parameters

pwa [in, out]

A pointer to a TP_WAIT structure that defines the wait object. The CreateThreadpoolWait function returns this structure.

h [in, optional]

A handle.

If this parameter is NULL, the wait object will cease to queue new callbacks (but callbacks already queued will still occur).

If this parameter is not NULL, it must refer to a valid waitable object.

If this handle is closed while the wait is still pending, the function's behavior is undefined. If the wait is still pending and the handle must be closed, use CloseThreadpoolWait to cancel the wait and then close the handle.

pftTimeout [in, optional]

A pointer to a FILETIME structure that specifies the absolute or relative time at which the wait operation should time out. If this parameter points to a positive value, it indicates the absolute time since January 1, 1601 (UTC), in 100-nanosecond intervals. If this parameter points to a negative value, it indicates the amount of time to wait relative to the current time. For more information about time values, see File Times.

If this parameter points to 0, the wait times out immediately. If this parameter is NULL, the wait will not time out.

Return value

This function does not return a value.

Remarks

You must re-register the event with the wait object before signaling it each time to trigger the wait callback.

To compile an application that uses this function, define _WIN32_WINNT as 0x0600 or higher.

Examples

For an example, see Using the Thread Pool Functions.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

WinBase.h on Windows Vista, Windows 7, Windows Server 2008, and Windows Server 2008 R2 (include Windows.h);
Threadpoolapiset.h on Windows 8 and Windows Server 2012

Library

Kernel32.lib

DLL

Kernel32.dll

See also

CloseThreadpoolWait
CreateThreadpoolWait
Thread Pools
WaitForThreadpoolWaitCallbacks

 

 

Community Additions

ADD
Show:
© 2014 Microsoft