home *** CD-ROM | disk | FTP | other *** search
/ C Programming Starter Kit 2.0 / SamsPublishing-CProgrammingStarterKit-v2.0-Win31.iso / bc45 / msinc.pak / MAPICODE.H < prev    next >
C/C++ Source or Header  |  1997-07-23  |  10KB  |  230 lines
  1. /*
  2.  *  M A P I C O D E . H
  3.  *
  4.  *  Status Codes returned by MAPI routines
  5.  *
  6.  *  Copyright 1993-1995 Microsoft Corporation. All Rights Reserved.
  7.  */
  8.  
  9. #ifndef MAPICODE_H
  10. #define MAPICODE_H
  11.  
  12. /* Define S_OK and ITF_* */
  13.  
  14. #ifdef WIN32
  15. #include <winerror.h>
  16. #endif
  17.  
  18. /*
  19.  *  MAPI Status codes follow the style of OLE 2.0 sCodes as defined in the
  20.  *  OLE 2.0 Programmer's Reference and header file scode.h (Windows 3.x)
  21.  *  or winerror.h (Windows NT 3.5 and Windows 95).
  22.  *
  23.  */
  24.  
  25. /*  On Windows 3.x, status codes have 32-bit values as follows:
  26.  *
  27.  *   3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
  28.  *   1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
  29.  *  +-+---------------------+-------+-------------------------------+
  30.  *  |S|       Context       | Facil |               Code            |
  31.  *  +-+---------------------+-------+-------------------------------+
  32.  *
  33.  *  where
  34.  *
  35.  *      S - is the severity code
  36.  *
  37.  *          0 - SEVERITY_SUCCESS
  38.  *          1 - SEVERITY_ERROR
  39.  *
  40.  *      Context - context info
  41.  *
  42.  *      Facility - is the facility code
  43.  *
  44.  *          0x0 - FACILITY_NULL     generally useful errors ([SE]_*)
  45.  *          0x1 - FACILITY_RPC      remote procedure call errors (RPC_E_*)
  46.  *          0x2 - FACILITY_DISPATCH late binding dispatch errors
  47.  *          0x3 - FACILITY_STORAGE  storage errors (STG_E_*)
  48.  *          0x4 - FACILITY_ITF      interface-specific errors
  49.  *
  50.  *      Code - is the facility's status code
  51.  *
  52.  *
  53.  */
  54.  
  55. /*
  56.  *  On Windows NT 3.5 and Windows 95, scodes are 32-bit values
  57.  *  laid out as follows:
  58.  *  
  59.  *    3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
  60.  *    1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
  61.  *   +-+-+-+-+-+---------------------+-------------------------------+
  62.  *   |S|R|C|N|r|    Facility         |               Code            |
  63.  *   +-+-+-+-+-+---------------------+-------------------------------+
  64.  *  
  65.  *   where
  66.  *  
  67.  *      S - Severity - indicates success/fail
  68.  *  
  69.  *          0 - Success
  70.  *          1 - Fail (COERROR)
  71.  *  
  72.  *      R - reserved portion of the facility code, corresponds to NT's
  73.  *          second severity bit.
  74.  *  
  75.  *      C - reserved portion of the facility code, corresponds to NT's
  76.  *          C field.
  77.  *  
  78.  *      N - reserved portion of the facility code. Used to indicate a
  79.  *          mapped NT status value.
  80.  *  
  81.  *      r - reserved portion of the facility code. Reserved for internal
  82.  *          use. Used to indicate HRESULT values that are not status
  83.  *          values, but are instead message ids for display strings.
  84.  *  
  85.  *      Facility - is the facility code
  86.  *          FACILITY_NULL                    0x0
  87.  *          FACILITY_RPC                     0x1
  88.  *          FACILITY_DISPATCH                0x2
  89.  *          FACILITY_STORAGE                 0x3
  90.  *          FACILITY_ITF                     0x4
  91.  *          FACILITY_WIN32                   0x7
  92.  *          FACILITY_WINDOWS                 0x8
  93.  *  
  94.  *      Code - is the facility's status code
  95.  *  
  96.  */
  97.  
  98.  
  99.  
  100.  
  101. /*
  102.  *  We can't use OLE 2.0 macros to build sCodes because the definition has
  103.  *  changed and we wish to conform to the new definition.
  104.  */
  105. #define MAKE_MAPI_SCODE(sev,fac,code) \
  106.     ((SCODE) (((unsigned long)(sev)<<31) | ((unsigned long)(fac)<<16) | ((unsigned long)(code))) )
  107.  
  108. /* The following two macros are used to build OLE 2.0 style sCodes */
  109.  
  110. #define MAKE_MAPI_E( err )  (MAKE_MAPI_SCODE( 1, FACILITY_ITF, err ))
  111. #define MAKE_MAPI_S( warn ) (MAKE_MAPI_SCODE( 0, FACILITY_ITF, warn ))
  112.  
  113. #ifdef  SUCCESS_SUCCESS
  114. #undef  SUCCESS_SUCCESS
  115. #endif
  116. #define SUCCESS_SUCCESS     0L
  117.  
  118. /* General errors (used by more than one MAPI object) */
  119.  
  120. #define MAPI_E_CALL_FAILED                              E_FAIL
  121. #define MAPI_E_NOT_ENOUGH_MEMORY                        E_OUTOFMEMORY
  122. #define MAPI_E_INVALID_PARAMETER                        E_INVALIDARG
  123. #define MAPI_E_INTERFACE_NOT_SUPPORTED                  E_NOINTERFACE
  124. #define MAPI_E_NO_ACCESS                                E_ACCESSDENIED
  125.  
  126. #define MAPI_E_NO_SUPPORT                               MAKE_MAPI_E( 0x102 )
  127. #define MAPI_E_BAD_CHARWIDTH                            MAKE_MAPI_E( 0x103 )
  128. #define MAPI_E_STRING_TOO_LONG                          MAKE_MAPI_E( 0x105 )
  129. #define MAPI_E_UNKNOWN_FLAGS                            MAKE_MAPI_E( 0x106 )
  130. #define MAPI_E_INVALID_ENTRYID                          MAKE_MAPI_E( 0x107 )
  131. #define MAPI_E_INVALID_OBJECT                           MAKE_MAPI_E( 0x108 )
  132. #define MAPI_E_OBJECT_CHANGED                           MAKE_MAPI_E( 0x109 )
  133. #define MAPI_E_OBJECT_DELETED                           MAKE_MAPI_E( 0x10A )
  134. #define MAPI_E_BUSY                                     MAKE_MAPI_E( 0x10B )
  135. #define MAPI_E_NOT_ENOUGH_DISK                          MAKE_MAPI_E( 0x10D )
  136. #define MAPI_E_NOT_ENOUGH_RESOURCES                     MAKE_MAPI_E( 0x10E )
  137. #define MAPI_E_NOT_FOUND                                MAKE_MAPI_E( 0x10F )
  138. #define MAPI_E_VERSION                                  MAKE_MAPI_E( 0x110 )
  139. #define MAPI_E_LOGON_FAILED                             MAKE_MAPI_E( 0x111 )
  140. #define MAPI_E_SESSION_LIMIT                            MAKE_MAPI_E( 0x112 )
  141. #define MAPI_E_USER_CANCEL                              MAKE_MAPI_E( 0x113 )
  142. #define MAPI_E_UNABLE_TO_ABORT                          MAKE_MAPI_E( 0x114 )
  143. #define MAPI_E_NETWORK_ERROR                            MAKE_MAPI_E( 0x115 )
  144. #define MAPI_E_DISK_ERROR                               MAKE_MAPI_E( 0x116 )
  145. #define MAPI_E_TOO_COMPLEX                              MAKE_MAPI_E( 0x117 )
  146. #define MAPI_E_BAD_COLUMN                               MAKE_MAPI_E( 0x118 )
  147. #define MAPI_E_EXTENDED_ERROR                           MAKE_MAPI_E( 0x119 )
  148. #define MAPI_E_COMPUTED                                 MAKE_MAPI_E( 0x11A )
  149. #define MAPI_E_CORRUPT_DATA                             MAKE_MAPI_E( 0x11B )
  150. #define MAPI_E_UNCONFIGURED                             MAKE_MAPI_E( 0x11C )
  151. #define MAPI_E_FAILONEPROVIDER                          MAKE_MAPI_E( 0x11D )
  152.  
  153. /* MAPI base function and status object specific errors and warnings */
  154.  
  155. #define MAPI_E_END_OF_SESSION                           MAKE_MAPI_E( 0x200 )
  156. #define MAPI_E_UNKNOWN_ENTRYID                          MAKE_MAPI_E( 0x201 )
  157. #define MAPI_E_MISSING_REQUIRED_COLUMN                  MAKE_MAPI_E( 0x202 )
  158. #define MAPI_W_NO_SERVICE                               MAKE_MAPI_S( 0x203 )
  159.  
  160. /* Property specific errors and warnings */
  161.  
  162. #define MAPI_E_BAD_VALUE                                MAKE_MAPI_E( 0x301 )
  163. #define MAPI_E_INVALID_TYPE                             MAKE_MAPI_E( 0x302 )
  164. #define MAPI_E_TYPE_NO_SUPPORT                          MAKE_MAPI_E( 0x303 )
  165. #define MAPI_E_UNEXPECTED_TYPE                          MAKE_MAPI_E( 0x304 )
  166. #define MAPI_E_TOO_BIG                                  MAKE_MAPI_E( 0x305 )
  167. #define MAPI_E_DECLINE_COPY                             MAKE_MAPI_E( 0x306 )
  168. #define MAPI_E_UNEXPECTED_ID                            MAKE_MAPI_E( 0x307 )
  169.  
  170. #define MAPI_W_ERRORS_RETURNED                          MAKE_MAPI_S( 0x380 )
  171.  
  172. /* Table specific errors and warnings */
  173.  
  174. #define MAPI_E_UNABLE_TO_COMPLETE                       MAKE_MAPI_E( 0x400 )
  175. #define MAPI_E_TIMEOUT                                  MAKE_MAPI_E( 0x401 )
  176. #define MAPI_E_TABLE_EMPTY                              MAKE_MAPI_E( 0x402 )
  177. #define MAPI_E_TABLE_TOO_BIG                            MAKE_MAPI_E( 0x403 )
  178.  
  179. #define MAPI_E_INVALID_BOOKMARK                         MAKE_MAPI_E( 0x405 )
  180.  
  181. #define MAPI_W_POSITION_CHANGED                         MAKE_MAPI_S( 0x481 )
  182. #define MAPI_W_APPROX_COUNT                             MAKE_MAPI_S( 0x482 )
  183.  
  184. /* Transport specific errors and warnings */
  185.  
  186. #define MAPI_E_WAIT                                     MAKE_MAPI_E( 0x500 )
  187. #define MAPI_E_CANCEL                                   MAKE_MAPI_E( 0x501 )
  188. #define MAPI_E_NOT_ME                                   MAKE_MAPI_E( 0x502 )
  189.  
  190. #define MAPI_W_CANCEL_MESSAGE                           MAKE_MAPI_S( 0x580 )
  191.  
  192. /* Message Store, Folder, and Message specific errors and warnings */
  193.  
  194. #define MAPI_E_CORRUPT_STORE                            MAKE_MAPI_E( 0x600 )
  195. #define MAPI_E_NOT_IN_QUEUE                             MAKE_MAPI_E( 0x601 )
  196. #define MAPI_E_NO_SUPPRESS                              MAKE_MAPI_E( 0x602 )
  197. #define MAPI_E_COLLISION                                MAKE_MAPI_E( 0x604 )
  198. #define MAPI_E_NOT_INITIALIZED                          MAKE_MAPI_E( 0x605 )
  199. #define MAPI_E_NON_STANDARD                             MAKE_MAPI_E( 0x606 )
  200. #define MAPI_E_NO_RECIPIENTS                            MAKE_MAPI_E( 0x607 )
  201. #define MAPI_E_SUBMITTED                                MAKE_MAPI_E( 0x608 )
  202. #define MAPI_E_HAS_FOLDERS                              MAKE_MAPI_E( 0x609 )
  203. #define MAPI_E_HAS_MESSAGES                             MAKE_MAPI_E( 0x60A )
  204. #define MAPI_E_FOLDER_CYCLE                             MAKE_MAPI_E( 0x60B )
  205.  
  206. #define MAPI_W_PARTIAL_COMPLETION                       MAKE_MAPI_S( 0x680 )
  207.  
  208. /* Address Book specific errors and warnings */
  209.  
  210. #define MAPI_E_AMBIGUOUS_RECIP                          MAKE_MAPI_E( 0x700 )
  211.  
  212. /* The range 0x0800 to 0x08FF is reserved */
  213.  
  214. /* Obsolete typing shortcut that will go away eventually. */
  215. #ifndef MakeResult
  216. #define MakeResult(_s)  ResultFromScode(_s)
  217. #endif
  218.  
  219. /* We expect these to eventually be defined by OLE, but for now,
  220.  * here they are.  When OLE defines them they can be much more
  221.  * efficient than these, but these are "proper" and don't make
  222.  * use of any hidden tricks.
  223.  */
  224. #ifndef HR_SUCCEEDED
  225. #define HR_SUCCEEDED(_hr) SUCCEEDED((SCODE)(_hr))
  226. #define HR_FAILED(_hr) FAILED((SCODE)(_hr))
  227. #endif
  228.  
  229. #endif  /* MAPICODE_H */
  230.