Vorbisfile documentation | vorbisfile version 1.3.2 - 20101101

# ov_test

declared in "vorbis/vorbisfile.h";

This partially opens a vorbis file to test for Vorbis-ness. It loads the headers for the first chain and tests for seekability (but does not seek). Use ov_test_open() to finish opening the file or ov_clear to close/free it. Note that vorbisfile does not take ownership of the file if the call fails; the calling applicaiton is responsible for closing the file if this call returns an error.

WARNING for Windows developers: Do not use ov_test() in Windows applications; Windows linking places restrictions on passing `FILE *` handles successfully, and ov_test() runs afoul of these restrictions [a] in exactly the same way as ov_open(). See the ov_test_callbacks() page for details on using ov_test_callbacks() instead.

    int ov_test(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);

### Parameters

f
  File pointer to an already opened file or pipe (it need not be seekable--though this obviously restricts what can be done with the bitstream).
vf
  A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile functions. Once this has been called, the same `OggVorbis_File` struct should be passed to all the libvorbisfile functions.
initial
  Typically set to NULL. This parameter is useful if some data has already been read from the file and the stream is not seekable. It is used in conjunction with `ibytes`. In this case, `initial` should be a pointer to a buffer containing the data read.
ibytes
  Typically set to 0. This parameter is useful if some data has already been read from the file and the stream is not seekable. In this case, `ibytes` should contain the length (in bytes) of the buffer. Used together with `initial`

### Return Values

> - 0 for success
> - less than zero for failure:
> - OV_EREAD - A read from media returned an error.
> - OV_ENOTVORBIS - Bitstream contains no Vorbis data.
> - OV_EVERSION - Vorbis version mismatch.
> - OV_EBADHEADER - Invalid Vorbis bitstream header.
> - OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.

### Notes

All the notes from ov_open() apply to ov_test().

copyright © 2000-2010 Xiph.Org | Ogg Vorbis
Vorbisfile documentation | vorbisfile version 1.3.2 - 20101101