changeset 5581:d205fac9f807 libavformat

Doxument url_read().
author stefano
date Sun, 24 Jan 2010 13:07:54 +0000
parents 07ce73fed19f
children ef37cc286c01
files avio.h
diffstat 1 files changed, 11 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/avio.h	Sat Jan 23 10:23:47 2010 +0000
+++ b/avio.h	Sun Jan 24 13:07:54 2010 +0000
@@ -68,7 +68,18 @@
 int url_open_protocol (URLContext **puc, struct URLProtocol *up,
                        const char *filename, int flags);
 int url_open(URLContext **h, const char *filename, int flags);
+
+/**
+ * Reads up to size bytes from the resource accessed by h, and stores
+ * the read bytes in buf.
+ *
+ * @return The number of bytes actually read, or a negative value
+ * corresponding to an AVERROR code in case of error. A value of zero
+ * indicates that it is not possible to read more from the accessed
+ * resource (except if the value of the size argument is also zero).
+ */
 int url_read(URLContext *h, unsigned char *buf, int size);
+
 /**
  * Read as many bytes as possible (up to size), calling the
  * read function multiple times if necessary.