PartyManager::GetOption

Retrieves an option used to fine-tune Party library functionality.

Syntax

PartyError GetOption(  
    const void* object,  
    PartyOption option,  
    void* value  
)  

Parameters

object   void*
optional

The Party library object that may be required as context for different PartyOption values.

option   PartyOption

The Party library option to retrieve.

value   void*
output

An output value to fill with the current option setting. If this option has not yet been overridden by a call to PartyManager::SetOption(), this method will retrieve that option's default value.

Return value

PartyError

c_partyErrorSuccess if the call succeeded or an error code otherwise.

Requirements

Header: Party.h

See also

PartyManager
PartyOption
PartyManager::SetOption