WaitCallback callback function
Applications implement this callback if they call the SetThreadpoolWait function to start a worker thread for the wait object.
The PTP_WAIT_CALLBACK type defines a pointer to this callback function. WaitCallback is a placeholder for the application-defined function name.
Syntax
VOID CALLBACK WaitCallback(
_Inout_ PTP_CALLBACK_INSTANCE Instance,
_Inout_opt_ PVOID Context,
_Inout_ PTP_WAIT Wait,
_In_ TP_WAIT_RESULT WaitResult
);
Parameters
Instance [in, out]
A TP_CALLBACK_INSTANCE structure that defines the callback instance. Applications do not modify the members of this structure.
This structure can be passed to one of the following functions:
- CallbackMayRunLong
- DisassociateCurrentThreadFromCallback
- FreeLibraryWhenCallbackReturns
- LeaveCriticalSectionWhenCallbackReturns
- ReleaseMutexWhenCallbackReturns
- ReleaseSemaphoreWhenCallbackReturns
- SetEventWhenCallbackReturns
Context [in, out, optional]
The application-defined data.
Wait [in, out]
A TP_WAIT structure that defines the wait object that generated the callback.
WaitResult [in]
The result of the wait operation. This parameter can be one of the following values from WaitForMultipleObjects:
WAIT_OBJECT_0
WAIT_TIMEOUT
Return value
This function does not return a value.
Requirements
Minimum supported client |
Windows Vista [desktop apps | UWP apps] |
Minimum supported server |
Windows Server 2008 [desktop apps | UWP apps] |
Header |
WinBase.h on Windows Vista, Windows 7, Windows Server 2008 and Windows Server 2008 R2 (include Windows.h); Threadpoolapiset.h on Windows 8 and Windows Server 2012 |