00001 ////////////////////////////////////////////////////////////////////////////// 00002 // hwapierr.h - Hex Workshop API Error Definitions 00003 // 00004 // This source code and information is provided "as is" without any warranty 00005 // of any kind, either expressed or implied, including but not limited to 00006 // the implied waranties of merchantability and/or fitness for a particular 00007 // purpose. 00008 // 00009 // Copyright (c) 2010 BreakPoint Software, Inc. All Rights Reserved. 00010 // 00011 ////////////////////////////////////////////////////////////////////////////// 00012 // 00013 //// 00014 00015 #ifndef _HWAPI_RESULT_H 00016 #define _HWAPI_RESULT_H /* [ */ 00017 00018 /** 00019 * @brief Hex Workshop Plug-in API Error Definitions 00020 * 00021 * hwapierr.h defines the Hex Workshop Plug-in error return codes for 00022 * functions defined in hwapi.h 00023 **/ 00024 00025 /** 00026 * @brief Hex Workshop Plug-in API return codes 00027 * @ingroup errors 00028 * 00029 * HWAPI_RESULT_SUCCESS (0) is return for a successful operations, otherwise the 00030 * operation failed and the return code indicates the failure cause. 00031 */ 00032 typedef enum HWAPI_RESULT 00033 { 00034 HWAPI_RESULT_SUCCESS = 0x00000000, /**< Success; no errors */ 00035 HWAPI_RESULT_OUTOFRANGE = 0x80000001, /**< An offset, index or length is out of bounds */ 00036 HWAPI_RESULT_CLOSED_DOCUMENT = 0x80000002, /**< Cannot operate on a closed document */ 00037 HWAPI_RESULT_INVALID_HWDOCUMENT = 0x80000003, /**< The HWDOCUMENT handle is not valid */ 00038 HWAPI_RESULT_INVALID_HWSESSION = 0x80000004, /**< The HWSESSION handle is not valid */ 00039 HWAPI_RESULT_INVALID_PARAMETER = 0x80000005, /**< An invalid parameter was passed to this API */ 00040 HWAPI_RESULT_NOT_IMPLEMENTED = 0x80000006, /**< The api method has not yet been implemented */ 00041 HWAPI_RESULT_BUFFER_TOO_SMALL = 0x80000007, /**< The supplied buffer it too small for the operation */ 00042 HWAPI_RESULT_USER_ABORT = 0x80000008, /**< The user aborted the operation */ 00043 HWAPI_RESULT_FAILED = 0x80000009, /**< The operation failed */ 00044 HWAPI_RESULT_NOT_FOUND = 0x8000000A, /**< Unable to find requested resource */ 00045 HWAPI_RESULT_INTERNAL_ERROR = 0xFFFFFFFF, /**< An internal unexpected error occured */ 00046 } HWAPI_RESULT ; 00047 00048 #endif /* ] */ 00049