PartyManager::SetWorkMode

Configures the work mode of the Party library processing task associated with threadId.

Syntax

PartyError SetWorkMode(  
    PartyThreadId threadId,  
    PartyWorkMode workMode  
)  

Parameters

threadId   PartyThreadId

A high-level categorization of the Party library's internal processing task.

workMode   PartyWorkMode

The target work mode for the associated processing task.

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

If the work mode is set as PartyWorkMode::Automatic, the processing task associated with threadId is handled internally by the Party library. If the work mode is configured as PartyWorkMode::Manual, the title must instead perform the processing task associated with threadId via periodic calls to DoWork().

This method can only be called when the Party library is uninitialized. Calling while initialized will fail and return an error.

Configuration of the work mode associated with threadId persists across subsequent calls to Cleanup() and Initialize().

Requirements

Header: Party.h

See also

PartyManager
PartyManager::GetWorkMode
PartyManager::DoWork