libsigrok
0.2.2
sigrok hardware access and backend library
Main Page
Related Pages
Modules
Data Structures
Files
File List
Globals
All
Data Structures
Files
Functions
Variables
Typedefs
Enumerator
Macros
Groups
Pages
error.c
Go to the documentation of this file.
1
/*
2
* This file is part of the libsigrok project.
3
*
4
* Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
5
*
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; either version 2 of the License, or
9
* (at your option) any later version.
10
*
11
* This program is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
15
*
16
* You should have received a copy of the GNU General Public License
17
* along with this program; if not, write to the Free Software
18
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19
*/
20
21
#include "
libsigrok.h
"
22
23
/**
24
* @file
25
*
26
* Error handling in libsigrok.
27
*/
28
29
/**
30
* @defgroup grp_error Error handling
31
*
32
* Error handling in libsigrok.
33
*
34
* libsigrok functions usually return @ref SR_OK upon success, or a negative
35
* error code on failure.
36
*
37
* @{
38
*/
39
40
/**
41
* Return a human-readable error string for the given libsigrok error code.
42
*
43
* @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
44
*
45
* @return A const string containing a short, human-readable (English)
46
* description of the error, such as "memory allocation error".
47
* The string must NOT be free'd by the caller!
48
*
49
* @see sr_strerror_name
50
*
51
* @since 0.2.0
52
*/
53
SR_API
const
char
*
sr_strerror
(
int
error_code)
54
{
55
/*
56
* Note: All defined SR_* error macros from libsigrok.h must have
57
* an entry in this function, as well as in sr_strerror_name().
58
*/
59
60
switch
(error_code) {
61
case
SR_OK
:
62
return
"no error"
;
63
case
SR_ERR
:
64
return
"generic/unspecified error"
;
65
case
SR_ERR_MALLOC
:
66
return
"memory allocation error"
;
67
case
SR_ERR_ARG
:
68
return
"invalid argument"
;
69
case
SR_ERR_BUG
:
70
return
"internal error"
;
71
case
SR_ERR_SAMPLERATE
:
72
return
"invalid samplerate"
;
73
case
SR_ERR_NA
:
74
return
"not applicable"
;
75
case
SR_ERR_DEV_CLOSED
:
76
return
"device closed but should be open"
;
77
case
SR_ERR_TIMEOUT
:
78
return
"timeout occurred"
;
79
default
:
80
return
"unknown error"
;
81
}
82
}
83
84
/**
85
* Return the "name" string of the given libsigrok error code.
86
*
87
* For example, the "name" of the SR_ERR_MALLOC error code is "SR_ERR_MALLOC",
88
* the name of the SR_OK code is "SR_OK", and so on.
89
*
90
* This function can be used for various purposes where the "name" string of
91
* a libsigrok error code is useful.
92
*
93
* @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
94
*
95
* @return A const string containing the "name" of the error code as string.
96
* The string must NOT be free'd by the caller!
97
*
98
* @see sr_strerror
99
*
100
* @since 0.2.0
101
*/
102
SR_API
const
char
*
sr_strerror_name
(
int
error_code)
103
{
104
/*
105
* Note: All defined SR_* error macros from libsigrok.h must have
106
* an entry in this function, as well as in sr_strerror().
107
*/
108
109
switch
(error_code) {
110
case
SR_OK
:
111
return
"SR_OK"
;
112
case
SR_ERR
:
113
return
"SR_ERR"
;
114
case
SR_ERR_MALLOC
:
115
return
"SR_ERR_MALLOC"
;
116
case
SR_ERR_ARG
:
117
return
"SR_ERR_ARG"
;
118
case
SR_ERR_BUG
:
119
return
"SR_ERR_BUG"
;
120
case
SR_ERR_SAMPLERATE
:
121
return
"SR_ERR_SAMPLERATE"
;
122
case
SR_ERR_NA
:
123
return
"SR_ERR_NA"
;
124
case
SR_ERR_DEV_CLOSED
:
125
return
"SR_ERR_DEV_CLOSED"
;
126
case
SR_ERR_TIMEOUT
:
127
return
"SR_ERR_TIMEOUT"
;
128
default
:
129
return
"unknown error code"
;
130
}
131
}
132
133
/** @} */
Generated on Mon Nov 4 2013 08:18:32 for libsigrok by
1.8.3.1