CreateThreadpoolWork

Creates a new work object.

Syntax

PTP_WORK CreateThreadpoolWork(
         PTP_WORK_CALLBACK pfnwk,
         PVOID pv,
         PTP_CALLBACK_ENVIRON pcbe
)  

Parameters

pfnwk
Type: PTP_WORK_CALLBACK 

[in] The callback function. A worker thread calls this callback each time you call SubmitThreadpoolWork to post the work object. For details, see WorkCallback.

pv
Type: PVOID 

[in, out, optional] Optional application-defined data to pass to the callback function.

pcbe
Type: PTP_CALLBACK_ENVIRON 

[in, optional] A TP_CALLBACK_ENVIRON structure that defines the environment in which to execute the callback. The InitializeThreadpoolEnvironment function returns this structure.

If this parameter is NULL, the callback executes in the default callback environment. For more information, see InitializeThreadpoolEnvironment.

Return value

Type: PTP_WORK 

If the function succeeds, it returns a TP_WORK structure that defines the work object. Applications do not modify the members of this structure.If the function fails, it returns NULL. To retrieve extended error information, call GetLastError.

Requirements

Header: Declared in threadpoolapiset.h.

Library: Use kernelx.lib.