XTaskQueueGetCurrentProcessTaskQueue

Obtains a handle to the process task queue, or nullptr if there is no process task queue.

Syntax

bool XTaskQueueGetCurrentProcessTaskQueue(  
         XTaskQueueHandle* queue  
)  

Parameters

queue   _Out_
Type: XTaskQueueHandle*

Handle to the process task queue.

Return value

Type: bool

Returns true if there is a process task queue available, or false otherwise.

Remarks

Note

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

By default, there is a process task queue that uses the thread pool for both work and completion ports. You can replace the default process task queue by calling XTaskQueueSetCurrentProcessTaskQueue, and you can prevent callers using the process task queue by calling XTaskQueueSetCurrentProcessTaskQueue with a null queue parameter.

Use XTaskQueueCloseHandle to close handle returned from this API.

Requirements

Header: XTaskQueue.h

Library: xgameruntime.lib

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

See also

XTaskQueue members
Asynchronous Programming Model
Async Task Queue Design