Changeset 26674 in vbox for trunk/include/iprt

Timestamp:

Feb 22, 2010 9:41:17 AM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

57891

Message:

iprt: Added RTMsgInitFailure for dealing with RTR3Init failures.

File:

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

trunk/include/iprt/message.h

@@ -70 +70 @@
 RTDECL(int)  RTMsgErrorV(const char *pszFormat, va_list va);
 
+/**
+ * Print an error message for a RTR3Init failure and suggest an exit code.
+ *
+ * @code
+ *
+ * int rc = RTR3Init();
+ * if (RT_FAILURE(rc))
+ *     return RTMsgInitFailure(rc);
+ *
+ * @endcode
+ *
+ * @returns Appropriate exit code.
+ * @param   rcRTR3Init      The status code returned by RTR3Init.
+ */
+RTDECL(int)  RTMsgInitFailure(int rcRTR3Init);
+
 /** @} */