PartyChatControl::GetCustomContext

Retrieves the app's private, custom pointer-sized context value previously associated with this chat control object.

Syntax

PartyError GetCustomContext(  
    void** customContext  
)  

Parameters

customContext   void**
output, may return nullptr

The output custom context.

Return value

PartyError

c_partyErrorSuccess if retrieving the custom context succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().

Remarks

If no custom context has been set yet, the value pointed to by customContext is set to nullptr.

Requirements

Header: Party.h

See also

PartyChatControl
PartyChatControl::SetCustomContext