Export (0) Print
Expand All
Expand Minimize

CloseThreadpoolWait function

Releases the specified wait object.

Syntax


VOID WINAPI CloseThreadpoolWait(
  _Inout_  PTP_WAIT pwa
);

Parameters

pwa [in, out]

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 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

CreateThreadpoolWait
SetThreadpoolWait
Thread Pools
WaitForThreadpoolWaitCallbacks

 

 

Community Additions

ADD
Show:
© 2014 Microsoft