PartyXblManager::SetThreadAffinityMask

Optionally configures the processor on which internal Party Xbox Live Helper library threads will run.

Syntax

PartyError SetThreadAffinityMask(  
    PartyXblThreadId threadId,  
    uint64_t threadAffinityMask  
)  

Parameters

threadId   PartyXblThreadId

The type of internal library thread for which processor affinity should be retrieved.

threadAffinityMask   uint64_t

The affinity mask for this type of Party thread.

Return value

PartyError

c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via GetErrorMessage().

Remarks

This method enables the application to configure the processor affinity for internal Party Xbox Live Helper library thread of a given type.

This method may be called at any time before or after Initialize() and will take effect immediately. Thread processor settings are persisted across calls to Cleanup() and Initialize(). When there are more than 64 cores present, this method always applies to processor group 0.

In order to specify any processor, pass c_anyProcessor as the threadAffinityMask parameter. This is also the default value the Party Xbox Live Helper library will use if this method is never called.

Requirements

Header: PartyXboxLive.h

See also

PartyXblManager
PartyXblThreadId
PartyXblManager::GetThreadAffinityMask