chat_manager::get_thread_processor

Retrieves the current processor on which internal Game Chat threads will run or are running.

Syntax

void get_thread_processor(  
    game_chat_thread_id threadId,  
    uint32_t* processorNumber  
)

threadId _In_
Type: game_chat_thread_id

The type of internal Game Chat thread for which processor affinity should be retrieved.
The internal thread to retrieve the process number for.

processorNumber _Out_
Type: uint32_t*

A place to store the zero-based processor number on which the internal Game Chat threads will run or are running.

Type: void

This retrieves the current processor affinity for internal Game Chat threads of a given type.

This method does not require chat_manager::initialize() to have been called first.

A reported value of c_anyProcessorNumber written to processorNumber indicates that the thread is free to run on any processor.

Note

c_anyProcessorNumber is a constexpr uint32_t with a value of 0xFFFFFFFF.

Note

This call will result in a fatal failure if a prior call to chat_manager::set_thread_affinity_mask has configured the Game Chat internal threads specified by threadID to run on more than one processor. In that case, chat_manager::get_thread_affinity_mask should be used instead.

Header: GameChat2.h

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