AVIStreamReadFormat

The AVIStreamReadFormat function reads the stream format data.

STDAPI AVIStreamReadFormat(
  PAVISTREAM pavi,  
  LONG lPos,        
  LPVOID lpFormat,  
  LONG * lpcbFormat 
);

Parameters

pavi

Handle to an open stream.

lPos

Position in the stream used to obtain the format data.

lpFormat

Pointer to a buffer to contain the format data.

lpcbFormat

Pointer to a location indicating the size of the memory block referenced by lpFormat. On return, the value is changed to indicate the amount of data read. If lpFormat is NULL, this parameter can be used to obtain the amount of memory needed to return the format.

Return Values

Returns zero if successful or an error otherwise.

The argument pavi is a pointer to an IAVIStream interface.

Requirements

  Windows NT/2000/XP: Included in Windows NT 3.1 and later.
  Windows 95/98/Me: Included in Windows 95 and later.
  Header: Declared in Vfw.h.
  Library: Use Vfw32.lib.

See Also

AVIFile Functions and Macros, AVIFile Functions

Show: