TpSetCallbackCleanupGroup function

Associates the specified cleanup group with the specified callback environment.

Syntax


VOID FORCEINLINE TpSetCallbackCleanupGroup(
  _Inout_  PTP_CALLBACK_ENVIRON              CallbackEnviron,
  _In_     PTP_CLEANUP_GROUP                 CleanupGroup,
  _In_opt_ PTP_CLEANUP_GROUP_CANCEL_CALLBACK CleanupGroupCancelCallback
);

Parameters

CallbackEnviron [in, out]

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

CleanupGroup [in]

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

CleanupGroupCancelCallback [in, optional]

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

This function does not return a value.

Remarks

This function is implemented as an inline function.

Requirements

Header

Winnt.h

See also

TpInitializeCallbackEnviron
TpDestroyCallbackEnviron
TpSetCallbackActivationContext
TpSetCallbackFinalizationCallback
TpSetCallbackLongFunction
TpSetCallbackNoActivationContext
TpSetCallbackPersistent
TpSetCallbackPriority
TpSetCallbackRaceWithDll
TpSetCallbackThreadpool

 

 

Show: