Expand Minimize

SetThreadpoolCallbackCleanupGroup function

Associates the specified cleanup group with the specified callback environment.

Syntax


VOID SetThreadpoolCallbackCleanupGroup(
  _Inout_   PTP_CALLBACK_ENVIRON pcbe,
  _In_      PTP_CLEANUP_GROUP ptpcg,
  _In_opt_  PTP_CLEANUP_GROUP_CANCEL_CALLBACK pfng
);

Parameters

pcbe [in, out]

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

ptpcg [in]

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

pfng [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.

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 (include Windows.h)

See also

DestroyThreadpoolEnvironment
InitializeThreadpoolEnvironment
SetThreadpoolCallbackLibrary
SetThreadpoolCallbackPool
SetThreadpoolCallbackPriority
SetThreadpoolCallbackRunsLong
Thread Pools

 

 

Community Additions

ADD
Show:
© 2014 Microsoft