4 <title>libogg - function - ogg_stream_check</title>
5 <link rel=stylesheet href="style.css" type="text/css">
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
9 <table border=0 width=100%>
11 <td><p class=tiny>libogg documentation</p></td>
12 <td align=right><p class=tiny>libogg release 1.3.5 - 20210603</p></td>
16 <h1>ogg_stream_check</h1>
18 <p><i>declared in "ogg/ogg.h";</i></p>
20 <p>This function is used to check the error or readiness condition of an <a href="ogg_stream_state.html">ogg_stream_state</a> structure.
21 <p>It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an
22 internal error occur, the <a href="ogg_stream_state.html">ogg_stream_state</a> structure will be cleared (equivalent to a
24 <a href="ogg_stream_clear.html">ogg_stream_clear</a>) and subsequent calls
25 using this <a href="ogg_stream_state.html">ogg_stream_state</a> will be
26 noops. Error detection is then handled via a single call to
27 ogg_stream_check at the end of the operational block. </p>
30 <table border=0 color=black cellspacing=0 cellpadding=7>
34 int ogg_stream_check(<a href="ogg_stream_state.html">ogg_stream_state</a> *os);
43 <dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct.</dd>
47 <h3>Return Values</h3>
50 0 is returned if the <a href="ogg_stream_state.html">ogg_stream_state</a> structure is initialized and ready.</li>
52 nonzero is returned if the structure was never initialized, or if an unrecoverable internal error occurred in a previous call using the passed in <a href="ogg_stream_state.html">ogg_stream_state</a> struct.</li>
58 <table border=0 width=100%>
60 <td><p class=tiny>copyright © 2000-2021 Xiph.Org Foundation</p></td>
61 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
63 <td><p class=tiny>libogg documentation</p></td>
64 <td align=right><p class=tiny>libogg release 1.3.5 - 20210603</p></td>