summaryrefslogtreecommitdiff
path: root/doc/libogg/ogg_stream_packetin.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/libogg/ogg_stream_packetin.html')
-rw-r--r--doc/libogg/ogg_stream_packetin.html5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/libogg/ogg_stream_packetin.html b/doc/libogg/ogg_stream_packetin.html
index 0e88afb..b8c8d02 100644
--- a/doc/libogg/ogg_stream_packetin.html
+++ b/doc/libogg/ogg_stream_packetin.html
@@ -50,7 +50,10 @@ int ogg_stream_packetin(ogg_stream_state *os,ogg_packet *op);
<h3>Return Values</h3>
<blockquote>
<li>
-0 is always returned.</li>
+0 returned on success. -1 returned in the event of internal error
+(currently only caused by a failed memory allocation, a case that can
+only occur on embedded systems. It is reasonable to ignore the return
+value innormal desktop applications).</li>
</blockquote>
<p>