libQuat
Loading...
Searching...
No Matches
Collaboration diagram for Error module:

Enumerations

enum  libquat_err { LIBQUAT_OK = 0 , LIBQUAT_BAD_VERSION , LIBQUAT_DIV_BY_ZERO }
 

Functions

LIBQUAT_DLL_EXPORTED const char * err_to_str (libquat_err err_code)
 
LIBQUAT_DLL_EXPORTED libquat_err libquat_version_check (const char major_ver)
 

Detailed Description

Enumeration Type Documentation

◆ libquat_err

Library return types indicating different error types.

Enumerator
LIBQUAT_OK 

No error

LIBQUAT_BAD_VERSION 

header and library version do not match

LIBQUAT_DIV_BY_ZERO 

Division by zero

38 {
39 LIBQUAT_OK = 0, /**< No error */
40 LIBQUAT_BAD_VERSION, /**< header and library version do not match */
41 LIBQUAT_DIV_BY_ZERO, /**< Division by zero */
libquat_err
Definition: libquat.h:38
@ LIBQUAT_OK
Definition: libquat.h:39
@ LIBQUAT_DIV_BY_ZERO
Definition: libquat.h:41
@ LIBQUAT_BAD_VERSION
Definition: libquat.h:40

Function Documentation

◆ err_to_str()

LIBQUAT_DLL_EXPORTED const char * err_to_str ( libquat_err  err_code)

Obtain descriptive string message for a libquat_err type error code.

Parameters
[in]err_codeerror code from the library api calls
Returns
error description string
15 {
16 switch (err_code) {
17 case LIBQUAT_OK:
18 return "OK.";
20 return "Division by zero.";
22 return "Header and library version do not match";
23 default:
24 return "Unknown error type.";
25 }
26}

◆ libquat_version_check()

LIBQUAT_DLL_EXPORTED libquat_err libquat_version_check ( const char  major_ver)

Function to check the version number of the library with the header.

Parameters
[in]major_verprovide major version as input
Returns
error of type libquat_err
28 {
29 if (is_libquat_valid) {
30 return LIBQUAT_OK;
31 }
32
33 if (libquat_major_ver != major_ver) {
35 }
36
38 return LIBQUAT_OK;
39}
char is_libquat_valid
Definition: libquat_err.c:13
static const char libquat_major_ver
Definition: libquat_internal.h:9