Wasabi ExpressPlay SDK for Embedded Systems  1.23.0
Data Fields
WSB_ResultExplanation Struct Reference

Structure that will be populated and returned by WSB_ExplainResult function. More...

#include <WsbResultHelper.h>

Data Fields

WSB_Boolean understood
 
const char * text
 whether or not the relevant WSB_Result error code is well understood by WSB_ExplainResult More...
 
const char * recommendation_text
 human-readable version of the WSB_Result error code More...
 
WSB_ResultRecommendation recommendation
 human-readable recommended action More...
 

Detailed Description

Structure that will be populated and returned by WSB_ExplainResult function.

It contains information about the action recommended by WSB_ExplainResult after that function has evaluated a particular WSB_Result. The "understood" field gives an indication as to whether or not the function understood the WSB_Result well enough to have a good chance of providing a reasonable recommended action.

Field Documentation

◆ recommendation

WSB_ResultRecommendation WSB_ResultExplanation::recommendation

human-readable recommended action

◆ recommendation_text

const char* WSB_ResultExplanation::recommendation_text

human-readable version of the WSB_Result error code

◆ text

const char* WSB_ResultExplanation::text

whether or not the relevant WSB_Result error code is well understood by WSB_ExplainResult

◆ understood

WSB_Boolean WSB_ResultExplanation::understood

The documentation for this struct was generated from the following file: