TrySubmitThreadpoolCallback function

Requests that a thread pool worker thread call the specified callback function.

Syntax

BOOL TrySubmitThreadpoolCallback(
  PTP_SIMPLE_CALLBACK  pfns,
  PVOID                pv,
  PTP_CALLBACK_ENVIRON pcbe
);

Parameters

pfns

The callback function. For details, see SimpleCallback.

pv

Optional application-defined data to pass to the callback function.

pcbe

A TP_CALLBACK_ENVIRON structure that defines the environment in which to execute the callback function. 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

If the function succeeds, it returns TRUE.

If the function fails, it returns FALSE. To retrieve extended error information, call GetLastError.

Remarks

To compile an application that uses this function, define _WIN32_WINNT as 0x0600 or higher.

Requirements

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

See Also

CallbackMayRunLong

DisassociateCurrentThreadFromCallback

FreeLibraryWhenCallbackReturns

InitializeThreadpoolEnvironment

LeaveCriticalSectionWhenCallbackReturns

ReleaseMutexWhenCallbackReturns

ReleaseSemaphoreWhenCallbackReturns

SetEventWhenCallbackReturns

Thread Pools