LibVLC core: remove exceptions

[vlc] / include / vlc / libvlc.h

diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h
index 31e11d3d3b0c583b8f27581cd8ed82edff879969..f364dab3323ec1a05cdd929077543eb76a7cd809 100644 (file)
--- a/include/vlc/libvlc.h
+++ b/include/vlc/libvlc.h
@@ -88,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.
@@ -165,13 +162,11 @@ const char *libvlc_printerr (const char *fmt, ...);
  * Create and initialize a libvlc instance.
  *
  * \param argc the number of arguments
- * \param argv command-line-type arguments. argv[0] must be the path of the
- *        calling program.
- * \param p_e an initialized exception pointer
- * \return the libvlc instance
+ * \param argv command-line-type arguments
+ * \return the libvlc instance or NULL in case of error
  */
 VLC_PUBLIC_API libvlc_instance_t *
-libvlc_new( int , const char *const *, libvlc_exception_t *);
+libvlc_new( int , const char *const * );
 
 /**
  * Decrement the reference count of a libvlc instance, and destroy it
@@ -194,12 +189,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.
@@ -239,24 +232,12 @@ VLC_PUBLIC_API const char * libvlc_get_changeset(void);
 
 struct vlc_object_t;
 
-/**
- * Get the internal main VLC object.
- * Use of this function is usually a hack and should be avoided.
- * @note
- * You will need to link with libvlccore to make any use of the underlying VLC
- * object. The libvlccore programming and binary interfaces are not stable.
- * @warning
- * Remember to release the object with vlc_object_release().
- *
- * \param p_instance the libvlc instance
- * @return a VLC object of type "libvlc"
- */
-VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *p_instance);
-
 /**
  * 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 );
 
@@ -297,13 +278,12 @@ typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
  * \param i_event_type the desired event to which we want to listen
  * \param f_callback the function to call when i_event_type occurs
  * \param user_data user provided data to carry with the event
- * \param p_e an initialized exception pointer
+ * \return 0 on success, ENOMEM on error
  */
-VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
-                                         libvlc_event_type_t i_event_type,
-                                         libvlc_callback_t f_callback,
-                                         void *user_data,
-                                         libvlc_exception_t *p_e );
+VLC_PUBLIC_API int libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
+                                        libvlc_event_type_t i_event_type,
+                                        libvlc_callback_t f_callback,
+                                        void *user_data );
 
 /**
  * Unregister an event notification.
@@ -312,13 +292,11 @@ VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager
  * \param i_event_type the desired event to which we want to unregister
  * \param f_callback the function to call when i_event_type occurs
  * \param p_user_data user provided data to carry with the event
- * \param p_e an initialized exception pointer
  */
 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
                                          libvlc_event_type_t i_event_type,
                                          libvlc_callback_t f_callback,
-                                         void *p_user_data,
-                                         libvlc_exception_t *p_e );
+                                         void *p_user_data );
 
 /**
  * Get an event's type name.
@@ -359,10 +337,9 @@ VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, uns
  * Open a VLC message log instance.
  *
  * \param p_instance libvlc instance
- * \param p_e an initialized exception pointer
- * \return log message instance
+ * \return log message instance or NULL on error
  */
-VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
+VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *);
 
 /**
  * Close a VLC message log instance.
@@ -393,10 +370,9 @@ VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
  * Allocate and returns a new iterator to messages in log.
  *
  * \param p_log libvlc log instance
- * \param p_e an initialized exception pointer
- * \return log iterator object
+ * \return log iterator object or NULL on error
  */
-VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
+VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t * );
 
 /**
  * Release a previoulsy allocated iterator.
@@ -420,12 +396,10 @@ VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_
  *
  * \param p_iter libvlc log iterator or NULL
  * \param p_buffer log buffer
- * \param p_e an initialized exception pointer
- * \return log message object
+ * \return log message object or NULL if none left
  */
 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
-                                                               libvlc_log_message_t *p_buffer,
-                                                               libvlc_exception_t *p_e );
+                                                               libvlc_log_message_t *p_buffer );
 
 /** @} */
 
@@ -434,3 +408,5 @@ VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterat
 # endif
 
 #endif /* <vlc/libvlc.h> */
+
+/** @} */