Mercurial > libavformat.hg

changeset 5632:4c2b20d0233c libavformat

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Doxument url_fdopen().
author stefano
date Fri, 05 Feb 2010 23:03:32 +0000
parents 5f128b4359e7
children 5d3ac5652047
files avio.h
diffstat 1 files changed, 11 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/avio.h	Fri Feb 05 15:14:56 2010 +0000
+++ b/avio.h	Fri Feb 05 23:03:32 2010 +0000
@@ -381,8 +381,17 @@
     return s->is_streamed;
 }
 
-/** @note when opened as read/write, the buffers are only used for
-    writing */
+/**
+ * Creates and initializes a ByteIOContext for accessing the
+ * resource referenced by the URLContext h.
+ * @note When the URLContext h has been opened in read+write mode, the
+ * ByteIOContext can be used only for writing.
+ *
+ * @param s Used to return the pointer to the created ByteIOContext.
+ * In case of failure the pointed to value is set to NULL.
+ * @return 0 in case of success, a negative value corresponding to an
+ * AVERROR code in case of failure
+ */
 int url_fdopen(ByteIOContext **s, URLContext *h);
 
 /** @warning must be called before any I/O */