Source code of Windows XP (NT5)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

248 lines
8.5 KiB

  1. /*
  2. * M A P I C O D E . H
  3. *
  4. * Status Codes returned by MAPI routines
  5. *
  6. * Copyright 1986-1999 Microsoft Corporation. All Rights Reserved.
  7. */
  8. #ifndef MAPICODE_H
  9. #define MAPICODE_H
  10. #if _MSC_VER > 1000
  11. #pragma once
  12. #endif
  13. #if defined (WIN32) && !defined (_WIN32)
  14. #define _WIN32
  15. #endif
  16. /* Define S_OK and ITF_* */
  17. #ifdef _WIN32
  18. #include <winerror.h>
  19. #endif
  20. /*
  21. * MAPI Status codes follow the style of OLE 2.0 sCodes as defined in the
  22. * OLE 2.0 Programmer's Reference and header file scode.h (Windows 3.x)
  23. * or winerror.h (Windows NT and Windows 95).
  24. *
  25. */
  26. /* On Windows 3.x, status codes have 32-bit values as follows:
  27. *
  28. * 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
  29. * 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
  30. * +-+---------------------+-------+-------------------------------+
  31. * |S| Context | Facil | Code |
  32. * +-+---------------------+-------+-------------------------------+
  33. *
  34. * where
  35. *
  36. * S - is the severity code
  37. *
  38. * 0 - SEVERITY_SUCCESS
  39. * 1 - SEVERITY_ERROR
  40. *
  41. * Context - context info
  42. *
  43. * Facility - is the facility code
  44. *
  45. * 0x0 - FACILITY_NULL generally useful errors ([SE]_*)
  46. * 0x1 - FACILITY_RPC remote procedure call errors (RPC_E_*)
  47. * 0x2 - FACILITY_DISPATCH late binding dispatch errors
  48. * 0x3 - FACILITY_STORAGE storage errors (STG_E_*)
  49. * 0x4 - FACILITY_ITF interface-specific errors
  50. *
  51. * Code - is the facility's status code
  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. * We can't use OLE 2.0 macros to build sCodes because the definition has
  99. * changed and we wish to conform to the new definition.
  100. */
  101. #define MAKE_MAPI_SCODE(sev,fac,code) \
  102. ((SCODE) (((unsigned long)(sev)<<31) | ((unsigned long)(fac)<<16) | ((unsigned long)(code))) )
  103. /* The following two macros are used to build OLE 2.0 style sCodes */
  104. #define MAKE_MAPI_E( err ) (MAKE_MAPI_SCODE( 1, FACILITY_ITF, err ))
  105. #define MAKE_MAPI_S( warn ) (MAKE_MAPI_SCODE( 0, FACILITY_ITF, warn ))
  106. #ifdef SUCCESS_SUCCESS
  107. #undef SUCCESS_SUCCESS
  108. #endif
  109. #define SUCCESS_SUCCESS 0L
  110. /* General errors (used by more than one MAPI object) */
  111. #define MAPI_E_CALL_FAILED E_FAIL
  112. #define MAPI_E_NOT_ENOUGH_MEMORY E_OUTOFMEMORY
  113. #define MAPI_E_INVALID_PARAMETER E_INVALIDARG
  114. #define MAPI_E_INTERFACE_NOT_SUPPORTED E_NOINTERFACE
  115. #define MAPI_E_NO_ACCESS E_ACCESSDENIED
  116. #define MAPI_E_NO_SUPPORT MAKE_MAPI_E( 0x102 )
  117. #define MAPI_E_BAD_CHARWIDTH MAKE_MAPI_E( 0x103 )
  118. #define MAPI_E_STRING_TOO_LONG MAKE_MAPI_E( 0x105 )
  119. #define MAPI_E_UNKNOWN_FLAGS MAKE_MAPI_E( 0x106 )
  120. #define MAPI_E_INVALID_ENTRYID MAKE_MAPI_E( 0x107 )
  121. #define MAPI_E_INVALID_OBJECT MAKE_MAPI_E( 0x108 )
  122. #define MAPI_E_OBJECT_CHANGED MAKE_MAPI_E( 0x109 )
  123. #define MAPI_E_OBJECT_DELETED MAKE_MAPI_E( 0x10A )
  124. #define MAPI_E_BUSY MAKE_MAPI_E( 0x10B )
  125. #define MAPI_E_NOT_ENOUGH_DISK MAKE_MAPI_E( 0x10D )
  126. #define MAPI_E_NOT_ENOUGH_RESOURCES MAKE_MAPI_E( 0x10E )
  127. #define MAPI_E_NOT_FOUND MAKE_MAPI_E( 0x10F )
  128. #define MAPI_E_VERSION MAKE_MAPI_E( 0x110 )
  129. #define MAPI_E_LOGON_FAILED MAKE_MAPI_E( 0x111 )
  130. #define MAPI_E_SESSION_LIMIT MAKE_MAPI_E( 0x112 )
  131. #define MAPI_E_USER_CANCEL MAKE_MAPI_E( 0x113 )
  132. #define MAPI_E_UNABLE_TO_ABORT MAKE_MAPI_E( 0x114 )
  133. #define MAPI_E_NETWORK_ERROR MAKE_MAPI_E( 0x115 )
  134. #define MAPI_E_DISK_ERROR MAKE_MAPI_E( 0x116 )
  135. #define MAPI_E_TOO_COMPLEX MAKE_MAPI_E( 0x117 )
  136. #define MAPI_E_BAD_COLUMN MAKE_MAPI_E( 0x118 )
  137. #define MAPI_E_EXTENDED_ERROR MAKE_MAPI_E( 0x119 )
  138. #define MAPI_E_COMPUTED MAKE_MAPI_E( 0x11A )
  139. #define MAPI_E_CORRUPT_DATA MAKE_MAPI_E( 0x11B )
  140. #define MAPI_E_UNCONFIGURED MAKE_MAPI_E( 0x11C )
  141. #define MAPI_E_FAILONEPROVIDER MAKE_MAPI_E( 0x11D )
  142. #define MAPI_E_UNKNOWN_CPID MAKE_MAPI_E( 0x11E )
  143. #define MAPI_E_UNKNOWN_LCID MAKE_MAPI_E( 0x11F )
  144. /* Flavors of E_ACCESSDENIED, used at logon */
  145. #define MAPI_E_PASSWORD_CHANGE_REQUIRED MAKE_MAPI_E( 0x120 )
  146. #define MAPI_E_PASSWORD_EXPIRED MAKE_MAPI_E( 0x121 )
  147. #define MAPI_E_INVALID_WORKSTATION_ACCOUNT MAKE_MAPI_E( 0x122 )
  148. #define MAPI_E_INVALID_ACCESS_TIME MAKE_MAPI_E( 0x123 )
  149. #define MAPI_E_ACCOUNT_DISABLED MAKE_MAPI_E( 0x124 )
  150. /* MAPI base function and status object specific errors and warnings */
  151. #define MAPI_E_END_OF_SESSION MAKE_MAPI_E( 0x200 )
  152. #define MAPI_E_UNKNOWN_ENTRYID MAKE_MAPI_E( 0x201 )
  153. #define MAPI_E_MISSING_REQUIRED_COLUMN MAKE_MAPI_E( 0x202 )
  154. #define MAPI_W_NO_SERVICE MAKE_MAPI_S( 0x203 )
  155. /* Property specific errors and warnings */
  156. #define MAPI_E_BAD_VALUE MAKE_MAPI_E( 0x301 )
  157. #define MAPI_E_INVALID_TYPE MAKE_MAPI_E( 0x302 )
  158. #define MAPI_E_TYPE_NO_SUPPORT MAKE_MAPI_E( 0x303 )
  159. #define MAPI_E_UNEXPECTED_TYPE MAKE_MAPI_E( 0x304 )
  160. #define MAPI_E_TOO_BIG MAKE_MAPI_E( 0x305 )
  161. #define MAPI_E_DECLINE_COPY MAKE_MAPI_E( 0x306 )
  162. #define MAPI_E_UNEXPECTED_ID MAKE_MAPI_E( 0x307 )
  163. #define MAPI_W_ERRORS_RETURNED MAKE_MAPI_S( 0x380 )
  164. /* Table specific errors and warnings */
  165. #define MAPI_E_UNABLE_TO_COMPLETE MAKE_MAPI_E( 0x400 )
  166. #define MAPI_E_TIMEOUT MAKE_MAPI_E( 0x401 )
  167. #define MAPI_E_TABLE_EMPTY MAKE_MAPI_E( 0x402 )
  168. #define MAPI_E_TABLE_TOO_BIG MAKE_MAPI_E( 0x403 )
  169. #define MAPI_E_INVALID_BOOKMARK MAKE_MAPI_E( 0x405 )
  170. #define MAPI_W_POSITION_CHANGED MAKE_MAPI_S( 0x481 )
  171. #define MAPI_W_APPROX_COUNT MAKE_MAPI_S( 0x482 )
  172. /* Transport specific errors and warnings */
  173. #define MAPI_E_WAIT MAKE_MAPI_E( 0x500 )
  174. #define MAPI_E_CANCEL MAKE_MAPI_E( 0x501 )
  175. #define MAPI_E_NOT_ME MAKE_MAPI_E( 0x502 )
  176. #define MAPI_W_CANCEL_MESSAGE MAKE_MAPI_S( 0x580 )
  177. /* Message Store, Folder, and Message specific errors and warnings */
  178. #define MAPI_E_CORRUPT_STORE MAKE_MAPI_E( 0x600 )
  179. #define MAPI_E_NOT_IN_QUEUE MAKE_MAPI_E( 0x601 )
  180. #define MAPI_E_NO_SUPPRESS MAKE_MAPI_E( 0x602 )
  181. #define MAPI_E_COLLISION MAKE_MAPI_E( 0x604 )
  182. #define MAPI_E_NOT_INITIALIZED MAKE_MAPI_E( 0x605 )
  183. #define MAPI_E_NON_STANDARD MAKE_MAPI_E( 0x606 )
  184. #define MAPI_E_NO_RECIPIENTS MAKE_MAPI_E( 0x607 )
  185. #define MAPI_E_SUBMITTED MAKE_MAPI_E( 0x608 )
  186. #define MAPI_E_HAS_FOLDERS MAKE_MAPI_E( 0x609 )
  187. #define MAPI_E_HAS_MESSAGES MAKE_MAPI_E( 0x60A )
  188. #define MAPI_E_FOLDER_CYCLE MAKE_MAPI_E( 0x60B )
  189. #define MAPI_W_PARTIAL_COMPLETION MAKE_MAPI_S( 0x680 )
  190. /* Address Book specific errors and warnings */
  191. #define MAPI_E_AMBIGUOUS_RECIP MAKE_MAPI_E( 0x700 )
  192. /* The range 0x0800 to 0x08FF is reserved */
  193. /* Obsolete typing shortcut that will go away eventually. */
  194. #ifndef MakeResult
  195. #define MakeResult(_s) ResultFromScode(_s)
  196. #endif
  197. /* We expect these to eventually be defined by OLE, but for now,
  198. * here they are. When OLE defines them they can be much more
  199. * efficient than these, but these are "proper" and don't make
  200. * use of any hidden tricks.
  201. */
  202. #ifndef HR_SUCCEEDED
  203. #define HR_SUCCEEDED(_hr) SUCCEEDED((SCODE)(_hr))
  204. #define HR_FAILED(_hr) FAILED((SCODE)(_hr))
  205. #endif
  206. #endif /* MAPICODE_H */
  207.