include/gammu-error.h

   1 /**
   2  * \file gammu-error.h
   3  * \author Michal Čihař
   4  *
   5  * Error codes definitions.
   6  */
   7 #ifndef __gammu_error_h
   8 #define __gammu_error_h
   9
  10 /**
  11  * \defgroup Error Error handling
  12  * Error handling and manipulation.
  13  */
  14
  15 /**
  16  * Error types.
  17  * \ingroup Error
  18  */
  19 typedef enum {
  20         /**
  21          * No error
  22          */
  23         ERR_NONE = 1,
  24         /**
  25          * Error during opening device
  26          */
  27         ERR_DEVICEOPENERROR,
  28         /**
  29          * Device locked
  30          */
  31         ERR_DEVICELOCKED,
  32         /**
  33          * Device does not exits
  34          */
  35         ERR_DEVICENOTEXIST,
  36         /**
  37          * Device is busy
  38          */
  39         ERR_DEVICEBUSY,
  40         /**
  41          * No permissions to open device
  42          */
  43         ERR_DEVICENOPERMISSION,
  44         /**
  45          * No driver installed for a device
  46          */
  47         ERR_DEVICENODRIVER,
  48         /**
  49          * Device doesn't seem to be working
  50          */
  51         ERR_DEVICENOTWORK,
  52         /**
  53          * Error during setting DTR/RTS in device
  54          */
  55         ERR_DEVICEDTRRTSERROR,
  56
  57         /** 10 **/
  58         /**
  59          * Error during changing speed in device
  60          */
  61         ERR_DEVICECHANGESPEEDERROR,
  62         /**
  63          * Error during writing device
  64          */
  65         ERR_DEVICEWRITEERROR,
  66         /**
  67          * Error during reading device
  68          */
  69         ERR_DEVICEREADERROR,
  70         /**
  71          * Can't set parity on device
  72          */
  73         ERR_DEVICEPARITYERROR,
  74         /**
  75          * Command timed out
  76          */
  77         ERR_TIMEOUT,
  78         /**
  79          * Frame handled, but not requested in this moment
  80          */
  81         ERR_FRAMENOTREQUESTED,
  82         /**
  83          * Response not handled by gammu
  84          */
  85         ERR_UNKNOWNRESPONSE,
  86         /**
  87          * Frame not handled by gammu
  88          */
  89         ERR_UNKNOWNFRAME,
  90         /**
  91          * Unknown connection type given by user
  92          */
  93         ERR_UNKNOWNCONNECTIONTYPESTRING,
  94         /**
  95          * Unknown model given by user
  96          */
  97         ERR_UNKNOWNMODELSTRING,
  98
  99         /** 20 **/
 100         /**
 101          * Some functions not compiled in your OS
 102          */
 103         ERR_SOURCENOTAVAILABLE,
 104         /**
 105          * Not supported by phone
 106          */
 107         ERR_NOTSUPPORTED,
 108         /**
 109          * Empty entry or transfer end.
 110          */
 111         ERR_EMPTY,
 112         /**
 113          * Not allowed
 114          */
 115         ERR_SECURITYERROR,
 116         /**
 117          * Too high or too low location...
 118          */
 119         ERR_INVALIDLOCATION,
 120         /**
 121          * Function not implemented
 122          */
 123         ERR_NOTIMPLEMENTED,
 124         /**
 125          * Memory is full
 126          */
 127         ERR_FULL,
 128         /**
 129          * Unknown response from phone
 130          */
 131         ERR_UNKNOWN,
 132         /**
 133          * Error during opening file
 134          */
 135         ERR_CANTOPENFILE,
 136         /**
 137          * More memory required
 138          */
 139         ERR_MOREMEMORY,
 140
 141         /** 30 **/
 142         /**
 143          * No permission
 144          */
 145         ERR_PERMISSION,
 146         /**
 147          * SMSC number is empty
 148          */
 149         ERR_EMPTYSMSC,
 150         /**
 151          * Inside phone menu - can't make something
 152          */
 153         ERR_INSIDEPHONEMENU,
 154         /**
 155          * Phone NOT connected - can't make something
 156          */
 157         ERR_NOTCONNECTED,
 158         /**
 159          * Work in progress
 160          */
 161         ERR_WORKINPROGRESS,
 162         /**
 163          * Phone is disabled and connected to charger
 164          */
 165         ERR_PHONEOFF,
 166         /**
 167          * File format not supported by Gammu
 168          */
 169         ERR_FILENOTSUPPORTED,
 170         /**
 171          * Found bug in implementation or phone
 172          */
 173         ERR_BUG,
 174         /**
 175          * Action was canceled by user
 176          */
 177         ERR_CANCELED,
 178         /**
 179          * Inside Gammu: phone module need to send another answer frame
 180          */
 181         ERR_NEEDANOTHERANSWER,
 182
 183         /** 40 **/
 184         /**
 185          * You need other connectin for this operation.
 186          */
 187         ERR_OTHERCONNECTIONREQUIRED,
 188         /**
 189          * Wrong CRC
 190          */
 191         ERR_WRONGCRC,
 192         /**
 193          * Invalid date/time
 194          */
 195         ERR_INVALIDDATETIME,
 196         /**
 197          * Phone memory error, maybe it is read only
 198          */
 199         ERR_MEMORY,
 200         /**
 201          * Invalid data given to phone
 202          */
 203         ERR_INVALIDDATA,
 204         /**
 205          * File with specified name already exist
 206          */
 207         ERR_FILEALREADYEXIST,
 208         /**
 209          * File with specified name doesn't exist
 210          */
 211         ERR_FILENOTEXIST,
 212         /**
 213          * You have to give folder (not file) name
 214          */
 215         ERR_SHOULDBEFOLDER,
 216         /**
 217          * You have to give file (not folder) name
 218          */
 219         ERR_SHOULDBEFILE,
 220         /**
 221          * Can not access SIM card
 222          */
 223         ERR_NOSIM,
 224
 225         /** 50 **/
 226         /**
 227          * Invalid gnapplet version
 228          */
 229         ERR_GNAPPLETWRONG,
 230         /**
 231          * Only part of folders listed
 232          */
 233         ERR_FOLDERPART,
 234         /**
 235          * Folder is not empty
 236          */
 237         ERR_FOLDERNOTEMPTY,
 238         /**
 239          * Data were converted
 240          */
 241         ERR_DATACONVERTED,
 242         /**
 243          * Gammu is not configured.
 244          */
 245         ERR_UNCONFIGURED,
 246         /**
 247          * Wrong folder selected (eg. for SMS).
 248          */
 249         ERR_WRONGFOLDER,
 250         /**
 251          * Internal phone error (phone got crazy).
 252          */
 253         ERR_PHONE_INTERNAL,
 254         /**
 255          * Could not write to a file (on local filesystem).
 256          */
 257         ERR_WRITING_FILE,
 258         /**
 259          * No such section exists.
 260          */
 261         ERR_NONE_SECTION,
 262         /**
 263          * Using default values.
 264          */
 265         ERR_USING_DEFAULTS,
 266
 267         /** 60 **/
 268         /**
 269          * Corrupted data returned by phone.
 270          */
 271         ERR_CORRUPTED,
 272         /**
 273          * Bad feature string.
 274          */
 275         ERR_BADFEATURE,
 276         /**
 277          * Some functions not compiled in your OS
 278          */
 279         ERR_DISABLED,
 280         /**
 281          * Bluetooth configuration requires channel option.
 282          */
 283         ERR_SPECIFYCHANNEL,
 284         /**
 285          * Service is not running.
 286          */
 287         ERR_NOTRUNNING,
 288         /**
 289          * Service setup is missing.
 290          */
 291         ERR_NOSERVICE,
 292         /**
 293          * Command failed. Try again.
 294          */
 295         ERR_BUSY,
 296         /**
 297          * Can not connect to server.
 298          */
 299         ERR_COULDNT_CONNECT,
 300         /**
 301          * Can not resolve host name.
 302          */
 303         ERR_COULDNT_RESOLVE,
 304         /**
 305          * Failed to get SMSC number from phone.
 306          */
 307         ERR_GETTING_SMSC,
 308
 309         /** 70 **/
 310         /**
 311          * Operation aborted.
 312          */
 313         ERR_ABORTED,
 314         /**
 315          * Installation data not found.
 316          */
 317         ERR_INSTALL_NOT_FOUND,
 318         /**
 319          * Entry is read only.
 320          */
 321         ERR_READ_ONLY,
 322
 323         /**
 324          * Just marker of highest error code, should not be used.
 325          */
 326         ERR_LAST_VALUE
 327 } GSM_Error;
 328
 329 /**
 330  * Returns text for error.
 331  *
 332  * \param e Error code.
 333  * \return Text (in current locales) describing error
 334  *
 335  * \ingroup Error
 336  */
 337 const char *GSM_ErrorString(GSM_Error e);
 338
 339 /**
 340  * Returns name for error.
 341  *
 342  * \param e Error code.
 343  * \return Text with error name
 344  *
 345  * \ingroup Error
 346  */
 347 const char *GSM_ErrorName(GSM_Error e);
 348 #endif
 349
 350 /* Editor configuration
 351  * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 352  */