XTaskQueueUnregisterWaiter

Article
06/22/2023

Unregisters a previously registered task queue waiter.

Syntax

void XTaskQueueUnregisterWaiter(  
         XTaskQueueHandle queue,  
         XTaskQueueRegistrationToken token  
)

Parameters

queue _In_
Type: XTaskQueueHandle

The queue to remove the waiter from.

token _In_
Type: XTaskQueueRegistrationToken

The registration token returned from XTaskQueueRegisterWaiter.

Return value

Type: void

Remarks

Note

This function isn't safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.

If XTaskQueueRegisterWaiter was previously invoked to register a waiter for a task queue, use XTaskQueueUnregisterWaiter to unregister the waiter identified by the XTaskQueueRegistrationToken specified in token. Once the specified waiter is unregistered, the Win32 handle is removed and the waiter callback is no longer invoked.

Requirements

Header: XTaskQueue.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

Share via