Edit

PartyManager::GetErrorMessage

  • Article

Get the human-readable form of an error generated by the Party library.

Syntax

PartyError GetErrorMessage(  
    PartyError error,  
    PartyString* errorMessage  
)

Parameters

error   PartyError

An error code.

errorMessage   PartyString*
library-allocated output

The output, human-readable error message. The memory for the returned string remains valid for the lifetime of the process.

Return value

PartyError

c_partyErrorSuccess if the call succeeded or an error code otherwise.

Remarks

These error messages are not localized and are only intended for developers, i.e. these error messages are not intended to be shown to users via UI.

Requirements

Header: Party.h

See also

PartyManager