libvlc_add_intf: remove dummy exception parameter

[vlc] / include / vlc / libvlc.h

diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h
index 431b80175a4cae19272935ad881762bad65ba3a9..e96ffb5e349e5da576a4c1aef10531c0af1aefb2 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>
 
 /*****************************************************************************
@@ -87,15 +88,12 @@ VLC_PUBLIC_API int
 libvlc_exception_raised( const libvlc_exception_t *p_exception );
 
 /**
- * Raise an exception using a user-provided message.
+ * Raise an exception.
  *
  * \param p_exception the exception to raise
- * \param psz_format the exception message format string
- * \param ... the format string arguments
  */
 VLC_PUBLIC_API void
-libvlc_exception_raise( libvlc_exception_t *p_exception,
-                        const char *psz_format, ... );
+libvlc_exception_raise( libvlc_exception_t *p_exception );
 
 /**
  * Clear an exception object so it can be reused.
@@ -105,18 +103,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_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.
+ */
+VLC_PUBLIC_API 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
  */
-VLC_PUBLIC_API const char *
-libvlc_exception_get_message( const libvlc_exception_t *p_exception );
+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
  *****************************************************************************/
@@ -160,12 +191,10 @@ VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
  *
  * \param p_instance the instance
  * \param name interface name, or NULL for default
- * \param p_exception an initialized exception pointer
  * \return 0 on success, -1 on error.
  */
 VLC_PUBLIC_API
-int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
-                     libvlc_exception_t *p_exception );
+int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name );
 
 /**
  * Waits until an interface causes the instance to exit.
@@ -223,6 +252,8 @@ VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *p
  * Frees an heap allocation (char *) returned by a LibVLC API.
  * If you know you're using the same underlying C run-time as the LibVLC
  * implementation, then you can call ANSI C free() directly instead.
+ *
+ * \param ptr the pointer
  */
 VLC_PUBLIC_API void libvlc_free( void *ptr );
 
@@ -309,21 +340,17 @@ VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_ty
  * Return the VLC messaging verbosity level.
  *
  * \param p_instance libvlc instance
- * \param p_e an initialized exception pointer
  * \return verbosity level for messages
  */
-VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
-                                                  libvlc_exception_t *p_e );
+VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
 
 /**
  * Set the VLC messaging verbosity level.
  *
  * \param p_instance libvlc log instance
  * \param level log level
- * \param p_e an initialized exception pointer
  */
-VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
-                                              libvlc_exception_t *p_e );
+VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
 
 /**
  * Open a VLC message log instance.
@@ -337,19 +364,17 @@ VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_except
 /**
  * Close a VLC message log instance.
  *
- * \param p_log libvlc log instance
- * \param p_e an initialized exception pointer
+ * \param p_log libvlc log instance or NULL
  */
-VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
+VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
 
 /**
  * Returns the number of messages in a log instance.
  *
- * \param p_log libvlc log instance
- * \param p_e an initialized exception pointer
- * \return number of log messages
+ * \param p_log libvlc log instance or NULL
+ * \return number of log messages, 0 if p_log is NULL
  */
-VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
+VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
 
 /**
  * Clear a log instance.
@@ -357,10 +382,9 @@ VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception
  * All messages in the log are removed. The log should be cleared on a
  * regular basis to avoid clogging.
  *
- * \param p_log libvlc log instance
- * \param p_e an initialized exception pointer
+ * \param p_log libvlc log instance or NULL
  */
-VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
+VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
 
 /**
  * Allocate and returns a new iterator to messages in log.
@@ -374,26 +398,24 @@ VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_
 /**
  * Release a previoulsy allocated iterator.
  *
- * \param p_iter libvlc log iterator
- * \param p_e an initialized exception pointer
+ * \param p_iter libvlc log iterator or NULL
  */
-VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
+VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
 
 /**
  * Return whether log iterator has more messages.
  *
- * \param p_iter libvlc log iterator
- * \param p_e an initialized exception pointer
+ * \param p_iter libvlc log iterator or NULL
  * \return true if iterator has more message objects, else false
  */
-VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
+VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
 
 /**
  * Return the next log message.
  *
  * The message contents must not be freed
  *
- * \param p_iter libvlc log iterator
+ * \param p_iter libvlc log iterator or NULL
  * \param p_buffer log buffer
  * \param p_e an initialized exception pointer
  * \return log message object
@@ -409,3 +431,5 @@ VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterat
 # endif
 
 #endif /* <vlc/libvlc.h> */
+
+/** @} */