AVIFileReadData

The AVIFileReadData function reads optional header data that applies to the entire file, such as author or copyright information.

STDAPI AVIFileReadData(
  PAVIFILE pfile, 
  DWORD ckid,     
  LPVOID lpData,  
  LONG * lpcbData 
);

Parameters

pfile

Handle to an open AVI file.

ckid

RIFF chunk identifier (four-character code) of the data.

lpData

Pointer to the buffer used to return the data read.

lpcbData

Pointer to a location indicating the size of the memory block referenced by lpData. If the data is read successfully, the value is changed to indicate the amount of data read.

Return Values

Returns zero if successful or an error otherwise. The return value AVIERR_NODATA indicates that data with the requested chunk identifier does not exist.

Remarks

The optional header information is custom and does not have a set format.

The argument pfile is a pointer to an IAVIFile 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: