XTaskQueueRegisterWaiter
Registers a wait handle with a task queue.Syntax
Parameters
queue _In_Type: XTaskQueueHandle The queue to submit the callback to. port _In_
Type: XTaskQueuePort The port to submit the callback to. Callbacks can be assigned to work or completion ports. waitHandle _In_
Type: HANDLE The handle to monitor.
This is the wait handle that, when signaled, will cause the callback to be invoked. The wait handle is typically an auto or manual reset event. If the wait handle is manual reset the callback will be invoked repeatedly as long as the event is signaled. If this isn’t what you want, either reset the event while in the callback or unregister the wait callback.
Type: void* An optional context pointer that will be passed to the callback. callback _In_
Type: XTaskQueueCallback* A pointer to the callback function. token _Out_
Type: XTaskQueueRegistrationToken* A registration token. This can be passed to XTaskQueueUnregisterWaiter to unregister the wait.
Return value
Type: HRESULT HRESULT success or error code.Remarks
This function isn’t safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.
Requirements
Header: XTaskQueue.h Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consolesConceptual documentation
See also
XTaskQueue membersAsynchronous Programming Model
Async Task Queue Design
