Changeset 8288 in vbox for trunk/include

Timestamp:

Apr 22, 2008 1:25:55 PM (17 years ago)

Author:

vboxsync

Message:

Added RTErrConvertFromDarwin() as a merge of the IO, Kern and COM versions.

File:

• trunk/include/iprt/err.h (modified) (1 diff)

trunk/include/iprt/err.h

@@ -92 +92 @@
  *
  * @returns iprt status code.
- * @param   iNativeCode    errno code.
+ * @param   iNativeCode    HRESULT error code.
+ * @remark  Darwin ring-3 only.
+ */
+RTDECL(int)  RTErrConvertFromDarwinCOM(int32_t iNativeCode);
+
+/**
+ * Converts a Darwin IOReturn error to an iprt status code.
+ *
+ * @returns iprt status code.
+ * @param   iNativeCode    IOReturn error code.
  * @remark  Darwin only.
  */
-RTDECL(int)  RTErrConvertFromDarwinCOM(int32_t iNativeCode);
-
-/**
- * Converts a Darwin IOReturn error to an iprt status code.
+RTDECL(int)  RTErrConvertFromDarwinIO(int iNativeCode);
+
+/**
+ * Converts a Darwin kern_return_t error to an iprt status code.
  *
  * @returns iprt status code.
- * @param   iNativeCode    errno code.
+ * @param   iNativeCode    kern_return_t error code.
  * @remark  Darwin only.
  */
-RTDECL(int)  RTErrConvertFromDarwinIO(int iNativeCode);
-
-/**
- * Converts a Darwin kern_return_t error to an iprt status code.
+RTDECL(int)  RTErrConvertFromDarwinKern(int iNativeCode);
+
+/**
+ * Converts a Darwin error to an iprt status code.
+ *
+ * This will consult RTErrConvertFromDarwinKern, RTErrConvertFromDarwinIO
+ * and RTErrConvertFromDarwinCOM in this order. The latter is ring-3 only as it
+ * doesn't apply elsewhere.
  *
  * @returns iprt status code.
- * @param   iNativeCode    errno code.
- * @remark  Darwin only.
- */
-RTDECL(int)  RTErrConvertFromDarwinKern(int iNativeCode);
+ * @param   iNativeCode    Darwin error code.
+ * @remarks Darwin only.
+ * @remarks This is recommended over RTErrConvertFromDarwinKern and RTErrConvertFromDarwinIO
+ *          since these are really just subsets of the same error space.
+ */
+RTDECL(int)  RTErrConvertFromDarwin(int iNativeCode);
 
 /**