Wasabi ExpressPlay SDK for Embedded Systems  1.23.0
WsbResultHelper.h
Go to the documentation of this file.
1 /*****************************************************************
2 |
3 | Wasabi - Result Helper
4 |
5 | $Id: WsbResultHelper.h 10793 2014-06-25 12:46:08Z jebaseelir $
6 | Original author: Adam Miller
7 |
8 | This software is provided to you pursuant to your agreement
9 | with Intertrust Technologies Corporation ("Intertrust").
10 | This software may be used only in accordance with the terms
11 | of the agreement.
12 |
13 | Copyright (c) 2008-2014 by Intertrust. All rights reserved.
14 |
15 ****************************************************************/
21 #ifndef _WSB_RESULT_HELPER_H_
22 #define _WSB_RESULT_HELPER_H_
23 
24 /*----------------------------------------------------------------------
25 | includes
26 +---------------------------------------------------------------------*/
27 #include "WsbTypes.h"
28 
29 #if defined(__cplusplus)
30 extern "C" {
31 #endif
32 
33 /*----------------------------------------------------------------------
34 | types
35 +---------------------------------------------------------------------*/
36 
41 typedef enum {
51 
60 typedef struct {
64  const char* text;
65  const char* recommendation_text;
66  WSB_ResultRecommendation recommendation;
68 
69 /*----------------------------------------------------------------------
70 | functions
71 +---------------------------------------------------------------------*/
72 
97 WSB_EXPORT WSB_ResultExplanation
98 WSB_ExplainResult(WSB_Result result, const char** languages, WSB_UInt32 language_count);
99 
102 #if defined(__cplusplus)
103 }
104 #endif
105 
106 #endif /* _WSB_RESULT_HELPER_H_ */
WSB_ResultRecommendation
Identifiers for possible recommended actions for the user to take when a WSB_Result other than WSB_SU...
Definition: WsbResultHelper.h:41
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.
Definition: WsbResultHelper.h:48
Definition: WsbResultHelper.h:42
WSB_Boolean
Boolean type used for variables that can be true (WSB_TRUE) or false (WSB_FALSE). ...
Definition: WsbTypes.h:71
Definition: WsbResultHelper.h:47
Definition: WsbResultHelper.h:43
const char * text
whether or not the relevant WSB_Result error code is well understood by WSB_ExplainResult ...
Definition: WsbResultHelper.h:64
Structure that will be populated and returned by WSB_ExplainResult function.
Definition: WsbResultHelper.h:60
WSB_Boolean understood
Definition: WsbResultHelper.h:61
const char * recommendation_text
human-readable version of the WSB_Result error code
Definition: WsbResultHelper.h:65
Definition: WsbResultHelper.h:46
Definition: WsbResultHelper.h:49
int WSB_Result
Signed integer value representing a function or method result (return value).
Definition: WsbTypes.h:83
Definition: WsbResultHelper.h:44
unsigned int WSB_UInt32
32-bit (or more) unsigned integer
Definition: WsbTypes.h:36
Wasabi Result.
WSB_ResultRecommendation recommendation
human-readable recommended action
Definition: WsbResultHelper.h:66
Definition: WsbResultHelper.h:45