IAVIStream::SetFormat method (vfw.h)

Article
02/22/2024

The SetFormat method sets format information in a stream. Called when an application uses the AVIStreamSetFormat function.

Syntax

HRESULT SetFormat(
  LONG   lPos,
  LPVOID lpFormat,
  LONG   cbFormat
);

Parameters

lPos

Pointer to the interface to a stream.

lpFormat

Pointer to the buffer for the format data.

cbFormat

Address containing the size, in bytes, of the buffer specified by lpFormat.

Return value

Returns the HRESULT defined by OLE.

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.

For handlers written in C++, SetFormat has the following syntax:


HRESULT SetFormat(LONG lPos, LPVOID lpFormat, LONG cbFormat)

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