Wasabi ExpressPlay SDK for iOS  1.23.0
Functions
WSB_ResultExplanation Class

High level Wasabi API result interpretation helper. More...

Functions

WSB_EXPORT WSB_ResultExplanation WSB_ExplainResult (WSB_Result result, const char **languages, WSB_UInt32 language_count)
 This function tries to guess the cause and possible best remedy for a given error. More...
 

Detailed Description

High level Wasabi API result interpretation helper.

Function Documentation

◆ WSB_ExplainResult()

WSB_EXPORT WSB_ResultExplanation WSB_ExplainResult ( WSB_Result  result,
const char **  languages,
WSB_UInt32  language_count 
)

This function tries to guess the cause and possible best remedy for a given error.

Parameters
resultThe WSB_Result error code for which this method tries to determine a suitable recommended action.
languagesAddress of an array of strings specifying the preferred languages for the human-readable text to be provided in the returned WSB_ResultExplanation, in order of preference. Each string specifies a language code from RFC 3066 (ftp://ftp.rfc-editor.org/in-notes/rfc3066.txt). The strings are each two letters (like "en" for English), and they are case-insensitive. ISO 639-1 codes are suggested. Note: This parameter is currently ignored.
language_countThe number of language strings in the languages parameter.
Returns
A WSB_ResultExplanation structure containing the recommended action.