diff avio.h @ 5587:0ab98b4a3778 libavformat

Doxument url_open().
author stefano
date Sun, 24 Jan 2010 22:07:32 +0000
parents 333f55aab3a2
children da4b8a105fd3
line wrap: on
line diff
--- a/avio.h	Sun Jan 24 21:37:35 2010 +0000
+++ b/avio.h	Sun Jan 24 22:07:32 2010 +0000
@@ -79,6 +79,17 @@
 int url_open_protocol (URLContext **puc, struct URLProtocol *up,
                        const char *url, int flags);
 
+/**
+ * Creates an URLContext for accessing to the resource indicated by
+ * url, and opens it.
+ *
+ * @param puc pointer to the location where, in case of success, the
+ * function puts the pointer to the created URLContext
+ * @param flags flags which control how the resource indicated by url
+ * is to be opened
+ * @return 0 in case of success, a negative value corresponding to an
+ * AVERROR code in case of failure
+ */
 int url_open(URLContext **h, const char *url, int flags);
 
 /**