Media discovery: remove exception

[vlc] / include / vlc / mediacontrol.h

diff --git a/include/vlc/mediacontrol.h b/include/vlc/mediacontrol.h
index 684aaaeb61a008d2b1c2882e849d8fe9a4a4146e..5b4f45d4cd002702530cdc2ed0185d5d51d0374c 100644 (file)
--- a/include/vlc/mediacontrol.h
+++ b/include/vlc/mediacontrol.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
- * control.h: global header for mediacontrol
+ * mediacontrol.h: global header for mediacontrol
  *****************************************************************************
- * Copyright (C) 2005 the VideoLAN team
+ * Copyright (C) 2005-2008 the VideoLAN team
  * $Id$
  *
  * Authors: Olivier Aubert <olivier.aubert@liris.univ-lyon1.fr>
@@ -21,6 +21,11 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * This file defines libvlc mediacontrol_* external API
+ */
+
 /**
  * \defgroup mediacontrol MediaControl
  * This is the MediaControl API, * intended to provide a generic API to movie players.
@@ -29,8 +34,8 @@
  */
 
 
-#ifndef _VLC_CONTROL_H
-#define _VLC_CONTROL_H 1
+#ifndef VLC_CONTROL_H
+#define VLC_CONTROL_H 1
 
 # ifdef __cplusplus
 extern "C" {
@@ -38,9 +43,9 @@ extern "C" {
 
 #if defined( WIN32 )
 #include <windows.h>
-#define WINDOWHANDLE HWND
+typedef HWND WINDOWHANDLE;
 #else
-#define WINDOWHANDLE int
+typedef int WINDOWHANDLE;
 #endif
 
 #include <vlc/libvlc.h>
@@ -94,7 +99,7 @@ mediacontrol_exception_cleanup( mediacontrol_Exception *exception );
 
 /**
  * Free an exception structure created with mediacontrol_exception_create().
- * \return the exception
+ * \param p_exception the exception to free.
  */
 VLC_PUBLIC_API void mediacontrol_exception_free(mediacontrol_Exception *exception);
 
@@ -286,7 +291,7 @@ VLC_PUBLIC_API void mediacontrol_sound_set_volume( mediacontrol_Instance *self,
  * \param visual_id the Xid or HWND, depending on the platform
  * \param exception an initialized exception pointer
  */
-VLC_PUBLIC_API bool mediacontrol_set_visual( mediacontrol_Instance *self,
+VLC_PUBLIC_API int mediacontrol_set_visual( mediacontrol_Instance *self,
                                     WINDOWHANDLE visual_id,
                                     mediacontrol_Exception *exception );