AVIFileReadData function (vfw.h)

Article
02/22/2024

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

Syntax

HRESULT 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 value

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

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	vfw.h
Library	Vfw32.lib
DLL	Avifil32.dll