AVIStreamReadData function (vfw.h)

Article
02/22/2024

The AVIStreamReadData function reads optional header data from a stream.

Syntax

HRESULT AVIStreamReadData(
  PAVISTREAM pavi,
  DWORD      fcc,
  LPVOID     lp,
  LONG       *lpcb
);

Parameters

pavi

Handle to an open stream.

fcc

Four-character code identifying the data.

lp

Pointer to the buffer to contain the optional header data.

lpcb

Pointer to the location that specifies the buffer size used for lpData. If the read is successful, AVIFile changes this value to indicate the amount of data written into the buffer for lpData.

Return value

Returns zero if successful or an error otherwise. The return value AVIERR_NODATA indicates the system could not find any data with the specified chunk identifier.

Remarks

This function retrieves only optional header information from the stream. This information is custom and does not have a set format.

The argument pavi is a pointer to an IAVIStream 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