Replace libvlc_exception_get_message with libvlc_errmsg

[vlc] / include / vlc / libvlc.h

diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h
index 4f27ad9f4cd0a801ad171159534372637fb3c844..1171dc8aaa014fa140db5ca4787b706b3e49a150 100644 (file)
--- a/include/vlc/libvlc.h
+++ b/include/vlc/libvlc.h
@@ -58,6 +58,7 @@
 extern "C" {
 # endif
 
+#include <stdarg.h>
 #include <vlc/libvlc_structures.h>
 
 /*****************************************************************************
@@ -105,18 +106,51 @@ libvlc_exception_raise( libvlc_exception_t *p_exception,
  */
 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
 
+/**@} */
+
+/*****************************************************************************
+ * Error handling
+ *****************************************************************************/
+/** \defgroup libvlc_error libvlc_error
+ * \ingroup libvlc_core
+ * LibVLC error handling
+ * @{
+ */
+
 /**
- * Get an exception's message.
+ * A human-readable error message for the last LibVLC error in the calling
+ * thread. The resulting string is valid until another error occurs (at least
+ * until the next LibVLC call).
  *
- * \param p_exception the exception to query
- * \return the exception message or NULL if not applicable (exception not
- *         raised, for example)
+ * @warning
+ * This will be NULL if there was no error.
  */
-VLC_PUBLIC_API const char *
-libvlc_exception_get_message( const libvlc_exception_t *p_exception );
+const char *libvlc_errmsg (void);
+
+/**
+ * Clears the LibVLC error status for the current thread. This is optional.
+ * By default, the error status is automatically overriden when a new error
+ * occurs, and destroyed when the thread exits.
+ */
+void libvlc_clearerr (void);
+
+/**
+ * Sets the LibVLC error status and message for the current thread.
+ * Any previous error is overriden.
+ * @return a nul terminated string in any case
+ */
+const char *libvlc_vprinterr (const char *fmt, va_list ap);
+
+/**
+ * Sets the LibVLC error status and message for the current thread.
+ * Any previous error is overriden.
+ * @return a nul terminated string in any case
+ */
+const char *libvlc_printerr (const char *fmt, ...);
 
 /**@} */
 
+
 /*****************************************************************************
  * Core handling
  *****************************************************************************/