CloseThreadpoolWait function

Releases the specified wait object.

Syntax

void CloseThreadpoolWait(
  PTP_WAIT pwa
);

Parameters

pwa

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

Return value

This function does not return a value.

Remarks

The wait object is freed immediately if there are no outstanding callbacks; otherwise, the timer object is freed asynchronously after the outstanding callbacks complete.

If there is a cleanup group associated with the wait object, it is not necessary to call this function; calling the CloseThreadpoolCleanupGroupMembers function releases the work, wait, and timer objects associated with the cleanup group.

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 | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header threadpoolapiset.h (include Windows 7, Windows Server 2008 Windows Server 2008 R2, Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

See also

CreateThreadpoolWait

SetThreadpoolWait

Thread Pools

WaitForThreadpoolWaitCallbacks