CloseThreadpoolCleanupGroup function (threadpoolapiset.h)

Article
02/22/2024

Closes the specified cleanup group.

Syntax

void CloseThreadpoolCleanupGroup(
  [in, out] PTP_CLEANUP_GROUP ptpcg
);

Parameters

[in, out] ptpcg

A pointer to a TP_CLEANUP_GROUP structure that defines the cleanup group. The CreateThreadpoolCleanupGroup returns this pointer.

Return value

None

Remarks

The cleanup group must have no members when you call this function. For information on removing members of the group, see CloseThreadpoolCleanupGroupMembers.

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

Requirement	Value
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.h on Windows 7, Windows Server 2008 Windows Server 2008 R2)
Library	Kernel32.lib
DLL	Kernel32.dll