2 * This file is part of the sigrok project.
4 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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
21 #include "libsigrok.h"
24 * Return a human-readable error string for the given libsigrok error code.
26 * @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
27 * @return A const string containing a short, human-readable (English)
28 * description of the error, such as "memory allocation error".
29 * The string must NOT be free'd by the caller!
30 * @see sr_strerror_name
32 SR_API const char *sr_strerror(int error_code)
37 * Note: All defined SR_* error macros from libsigrok.h should have
38 * an entry in this function, as well as in sr_strerror_name().
46 str = "generic/unspecified error";
49 str = "memory allocation error";
52 str = "internal error";
54 case SR_ERR_SAMPLERATE:
55 str = "invalid samplerate";
58 str = "unknown error";
66 * Return the "name" string of the given libsigrok error code.
68 * For example, the "name" of the SR_ERR_MALLOC error code is "SR_ERR_MALLOC",
69 * the name of the SR_OK code is "SR_OK", and so on.
71 * This function can be used for various purposes where the "name" string of
72 * a libsigrok error code is useful.
74 * @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
75 * @return A const string containing the "name" of the error code as string.
76 * The string must NOT be free'd by the caller!
79 SR_API const char *sr_strerror_name(int error_code)
84 * Note: All defined SR_* error macros from libsigrok.h should have
85 * an entry in this function, as well as in sr_strerror().
96 str = "SR_ERR_MALLOC";
101 case SR_ERR_SAMPLERATE:
102 str = "SR_ERR_SAMPLERATE";
105 str = "unknown error code";