AVIFileCreateStreamW function (vfw.h)

Article
02/22/2024

The AVIFileCreateStream function creates a new stream in an existing file and creates an interface to the new stream.

Syntax

HRESULT AVIFileCreateStreamW(
  PAVIFILE       pfile,
  PAVISTREAM     *ppavi,
  AVISTREAMINFOW *psi
);

Parameters

pfile

Handle to an open AVI file.

ppavi

Pointer to the new stream interface.

psi

Pointer to a structure containing information about the new stream, including the stream type and its sample rate.

Return value

Returns zero if successful or an error otherwise. Unless the file has been opened with write permission, this function returns AVIERR_READONLY.

Remarks

This function starts a reference count for the new stream.

The argument pfile is a pointer to an IAVIFile interface. The argument ppavi is a pointer to an IAVIStream interface.

Note

The vfw.h header defines AVIFileCreateStream as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

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