TpSetCallbackCleanupGroup function (winnt.h)

Article
02/22/2024

Associates the specified cleanup group with the specified callback environment.

Syntax

void TpSetCallbackCleanupGroup(
  [in, out]      PTP_CALLBACK_ENVIRON              CallbackEnviron,
  [in]           PTP_CLEANUP_GROUP                 CleanupGroup,
  [in, optional] PTP_CLEANUP_GROUP_CANCEL_CALLBACK CleanupGroupCancelCallback
);

Parameters

[in, out] CallbackEnviron

A TP_CALLBACK_ENVIRON structure that defines the callback environment. The TpInitializeCallbackEnviron function returns this structure.

[in] CleanupGroup

A TP_CLEANUP_GROUP structure that defines the cleanup group. The CreateThreadpoolCleanupGroup function returns this structure.

[in, optional] CleanupGroupCancelCallback

The cleanup callback to be called if the cleanup group is canceled before the associated object is released. The function is called when you call CloseThreadpoolCleanupGroupMembers.

Return value

None

Remarks

This function is implemented as an inline function.

Requirements

Requirement	Value
Target Platform	Windows
Header	winnt.h