C API for BALTECH SDK
names.h
Go to the documentation of this file.
1 
10 #ifndef __NAMES_H__
11 #define __NAMES_H__
12 
13 
14 #include "common.h"
15 #include "errorcodes.h"
16 
17 
24 BRP_LIB char * brp_map_errcode(brp_errcode errcode);
25 
26 
32 BRP_LIB char * brp_map_errcode_to_desc(brp_errcode errcode);
33 
34 
40 BRP_LIB char * brp_map_errcode_to_docurl(brp_errcode errcode);
41 
42 
48 BRP_LIB char * brp_map_cmdcode(unsigned cmd_code);
49 
50 
56 BRP_LIB char * brp_map_cmdcode_to_docurl(unsigned cmd_code);
57 
58 
59 
60 #endif
61  // end of defgroup brp_lib
brp_map_errcode
BRP_LIB char * brp_map_errcode(brp_errcode errcode)
Retrieve name of errorcode.
errorcodes.h
Contains all possible error codes that could be returned by BRP library.
brp_errcode
unsigned int brp_errcode
This type is used library-wide for passing error codes in the return value of functions.
Definition: errorcodes.h:23
brp_map_cmdcode_to_docurl
BRP_LIB char * brp_map_cmdcode_to_docurl(unsigned cmd_code)
Retrieve URL of the documentation describing the passed cmdcode.
brp_map_cmdcode
BRP_LIB char * brp_map_cmdcode(unsigned cmd_code)
Retrieve the name of a (16bit) cmdcode as C string.
brp_map_errcode_to_docurl
BRP_LIB char * brp_map_errcode_to_docurl(brp_errcode errcode)
Retrieve URL of the documentation describing the passed errcode.
common.h
Contains the basic defines that are required throughout the BRP library.
brp_map_errcode_to_desc
BRP_LIB char * brp_map_errcode_to_desc(brp_errcode errcode)
Retrieve textual description of errorcode in english.