msp/result.h

   1 /**
   2 * \file
   3 * \brief Defines some generic result codes
   4 * \author Alex Mykyta
   5 * \date 7/1/2011
   6 *
   7 * This file includes some generic function responses that are used universally thoughout all of
   8 * the modules. See function-specific documentation for more detailed descriptions regarding the
   9 * responses.
  10 **/
  11
  12 #ifndef RESULT_H_
  13 #define RESULT_H_
  14
  15 typedef enum{
  16         RES_OK,                 ///< Function executed successfully
  17         RES_FAIL,               ///< Function failed to execute properly
  18         RES_INVALID,    ///< Parameters returned are not valid
  19         RES_NOTFOUND,   ///< Item requested was not found
  20         RES_FULL,               ///< Buffer/Memory/other is full
  21         RES_UNDERRUN,   ///< Buffer underrun has occurred
  22         RES_OVERRUN,    ///< Buffer overrun has occured
  23         RES_PARAMERR,   ///< Invalid input parameter
  24         RES_END,                ///< Reached the end of a buffer
  25         RES_BUSY,               ///< Device is busy
  26         RES_CANCEL,             ///< Operation has been cancelled
  27         RES_UNKNOWN             ///< Unknown Error
  28 } RES_t;
  29
  30 #endif /*RESULT_H_*/