AVIFileGetStream function (vfw.h)

Article
02/22/2024

The AVIFileGetStream function returns the address of a stream interface that is associated with a specified AVI file.

Syntax

HRESULT AVIFileGetStream(
  PAVIFILE   pfile,
  PAVISTREAM *ppavi,
  DWORD      fccType,
  LONG       lParam
);

Parameters

pfile

Handle to an open AVI file.

ppavi

Pointer to the new stream interface.

fccType

Four-character code indicating the type of stream to open. Zero indicates any stream can be opened. The following definitions apply to the data commonly found in AVI streams.

Value	Description
streamtypeAUDIO	Indicates an audio stream.
streamtypeMIDI	Indicates a MIDI stream.
streamtypeTEXT	Indicates a text stream.
streamtypeVIDEO	Indicates a video stream.

lParam

Count of the stream type. Identifies which occurrence of the specified stream type to access.

Return value

Returns zero if successful or an error otherwise. Possible error values include the following.

Return code	Description
AVIERR_NODATA	The file does not contain a stream corresponding to the values of fccType and lParam.
AVIERR_MEMORY	Not enough memory.

Remarks

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