AVIStreamReadFormat function (vfw.h)

Article
02/22/2024

The AVIStreamReadFormat function reads the stream format data.

Syntax

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

Returns zero if successful or an error otherwise.

The argument pavi is a pointer to an IAVIStream interface.

Remarks

Standard video stream handlers provide format information in a BITMAPINFOHEADER structure. Standard audio stream handlers provide format information in a PCMWAVEFORMAT structure. Other data streams can use other structures that describe the stream data.

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