Remove libvlc_free

[vlc] / include / vlc / libvlc.h

diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h
index 6de7328bf5ec039a8546f8289eec6bb729f82642..51bb78f4c2f55a3520b207caa0730891347a7a4e 100644 (file)
--- a/include/vlc/libvlc.h
+++ b/include/vlc/libvlc.h
@@ -61,50 +61,6 @@ extern "C" {
 #include <stdarg.h>
 #include <vlc/libvlc_structures.h>
 
-/*****************************************************************************
- * Exception handling
- *****************************************************************************/
-/** \defgroup libvlc_exception libvlc_exception
- * \ingroup libvlc_core
- * LibVLC Exceptions handling
- * @{
- */
-
-/**
- * Initialize an exception structure. This can be called several times to
- * reuse an exception structure.
- *
- * \param p_exception the exception to initialize
- */
-VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
-
-/**
- * Has an exception been raised?
- *
- * \param p_exception the exception to query
- * \return 0 if the exception was raised, 1 otherwise
- */
-VLC_PUBLIC_API int
-libvlc_exception_raised( const libvlc_exception_t *p_exception );
-
-/**
- * Raise an exception.
- *
- * \param p_exception the exception to raise
- */
-VLC_PUBLIC_API void
-libvlc_exception_raise( libvlc_exception_t *p_exception );
-
-/**
- * Clear an exception object so it can be reused.
- * The exception object must have be initialized.
- *
- * \param p_exception the exception to clear
- */
-VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
-
-/**@} */
-
 /*****************************************************************************
  * Error handling
  *****************************************************************************/
@@ -162,13 +118,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 argc , const char *const *argv );
 
 /**
  * Decrement the reference count of a libvlc instance, and destroy it
@@ -176,7 +130,7 @@ libvlc_new( int , const char *const *, libvlc_exception_t *);
  *
  * \param p_instance the instance to destroy
  */
-VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
+VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *p_instance );
 
 /**
  * Increments the reference count of a libvlc instance.
@@ -184,7 +138,7 @@ VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
  *
  * \param p_instance the instance to reference
  */
-VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
+VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t *p_instance );
 
 /**
  * Try to start a user interface for the libvlc instance.
@@ -234,29 +188,6 @@ 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 );
-
 /** @}*/
 
 /*****************************************************************************
@@ -317,7 +248,7 @@ VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager
 /**
  * Get an event's type name.
  *
- * \param i_event_type the desired event
+ * \param event_type the desired event
  */
 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
 
@@ -353,10 +284,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 *p_instance );
 
 /**
  * Close a VLC message log instance.
@@ -387,10 +317,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 *p_log );
 
 /**
  * Release a previoulsy allocated iterator.
@@ -414,12 +343,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 );
 
 /** @} */