From 373dc625f82b47096893add42c4472e4a57ab7eb Mon Sep 17 00:00:00 2001 From: Aki Date: Wed, 9 Feb 2022 22:23:03 +0100 Subject: Moved third-party libraries to a separate subdirectory --- contrib/ogg/doc/libogg/oggpack_writecheck.html | 81 ++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 contrib/ogg/doc/libogg/oggpack_writecheck.html (limited to 'contrib/ogg/doc/libogg/oggpack_writecheck.html') diff --git a/contrib/ogg/doc/libogg/oggpack_writecheck.html b/contrib/ogg/doc/libogg/oggpack_writecheck.html new file mode 100644 index 0000000..e23131b --- /dev/null +++ b/contrib/ogg/doc/libogg/oggpack_writecheck.html @@ -0,0 +1,81 @@ + + + +libogg - function - oggpack_writecheck + + + + + + + + + +

libogg documentation

libogg release 1.3.2 - 20140527

+ +

oggpack_writecheck

+ +

declared in "ogg/ogg.h";

+ +

This function checks the readiness status of +an oggpack_buffer previously +initialized for writing using the +Ogg bitpacking functions. A write +buffer that encounters an error (such as a failed malloc) will clear +its internal state and release any in-use memory, flagging itself as +'not ready'. Subsequent attempts to write using the buffer will +silently fail. This error state may be detected at any later time by +using oggpack_writecheck(). It is safe but not necessary to +call oggpack_writeclear() on a buffer that +has flagged an error and released its resources. + +

Important note to developers: Although libogg checks the +results of memory allocations, these checks are only useful on a +narrow range of embedded platforms. Allocation checks perform no +useful service on a general purpose desktop OS where pages are +routinely overallocated and all allocations succeed whether memory is +available or not. The only way to detect an out of memory condition +on the vast majority of OSes is to watch for and capture segmentation +faults. This function is useful only to embedded developers. + +

+ + + + +
+
+int oggpack_writecheck(oggpack_buffer *b); +
+
+ +

Parameters

b: An oggpack_buffer previously initialized for writing.

+ + +

Return Values

+
zero: buffer is ready for writing
+
nonzero: buffer is not ready or encountered an error
+

+ +

+

+ + + + + + + + +

copyright © 2000-2014 Xiph.Org	Ogg Container Format
libogg documentation	libogg release 1.3.2 - 20140527

+ + + + + -- cgit v1.1