summaryrefslogtreecommitdiff
path: root/libavformat/avio.h
diff options
context:
space:
mode:
authorAnton Khirnov <anton@khirnov.net>2011-04-09 12:43:51 +0200
committerAnton Khirnov <anton@khirnov.net>2011-04-10 07:41:56 +0200
commite782a0c6da0daa7b65e0355e50e68b13441b5faa (patch)
tree155cde5f89a32b72431881dd4f6ea03157fcb451 /libavformat/avio.h
parent893816ba1e7c8d89ee405e55bae8251366ff3df9 (diff)
avio: document avio_close().
Diffstat (limited to 'libavformat/avio.h')
-rw-r--r--libavformat/avio.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/libavformat/avio.h b/libavformat/avio.h
index ca5dc2d1ee..134df12057 100644
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -555,6 +555,12 @@ int url_resetbuf(AVIOContext *s, int flags);
*/
int avio_open(AVIOContext **s, const char *url, int flags);
+/**
+ * Close the resource accessed by the AVIOContext s and free it.
+ * This function can only be used if s was opened by avio_open().
+ *
+ * @return 0 on success, an AVERROR < 0 on error.
+ */
int avio_close(AVIOContext *s);
/**