cannam@86: cannam@86: cannam@86: cannam@86: libogg - function - ogg_stream_destroy cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

libogg documentation

libogg release 1.3.0 - 20110804

cannam@86: cannam@86:

ogg_stream_destroy

cannam@86: cannam@86:

declared in "ogg/ogg.h";

cannam@86: cannam@86:

This function frees the internal memory used by cannam@86: the ogg_stream_state struct as cannam@86: well as the structure itself. cannam@86: cannam@86:

This should be called when you are done working with an ogg stream. cannam@86: It can also be called to make sure that the struct does not exist.

cannam@86: cannam@86:

It calls free() on its argument, so if the ogg_stream_state cannam@86: is not malloc()'d or will otherwise be freed by your own code, use cannam@86: ogg_stream_clear instead.

cannam@86: cannam@86:

cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:
cannam@86:

cannam@86: int ogg_stream_destroy(ogg_stream_state *os);
cannam@86: 
cannam@86:
cannam@86: cannam@86:

Parameters

cannam@86:
cannam@86:
os
cannam@86:
Pointer to the ogg_stream_state struct to be destroyed.
cannam@86:
cannam@86: cannam@86: cannam@86:

Return Values

cannam@86:
cannam@86:
  • cannam@86: 0 is always returned.
  • cannam@86:
    cannam@86:

    cannam@86: cannam@86:

    cannam@86:


    cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

    copyright © 2000-2011 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.0 - 20110804

    cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: