AVIStreamSetFormat function (vfw.h)

Article
02/22/2024

The AVIStreamSetFormat function sets the format of a stream at the specified position.

Syntax

HRESULT AVIStreamSetFormat(
  PAVISTREAM pavi,
  LONG       lPos,
  LPVOID     lpFormat,
  LONG       cbFormat
);

Parameters

pavi

Handle to an open stream.

lPos

Position in the stream to receive the format.

lpFormat

Pointer to a structure containing the new format.

cbFormat

Size, in bytes, of the block of memory referenced by lpFormat.

Return value

Returns zero if successful or an error otherwise.

Remarks

The handler for writing AVI files does not accept format changes. Besides setting the initial format for a stream, only changes in the palette of a video stream are allowed in an AVI file. The palette change must occur after any frames already written to the AVI file. Other handlers might impose different restrictions.

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