IAVIStream::SetFormat

  • Article

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

HRESULT SetFormat (
  PAVISTREAM ps,    
  LPVOID lpFormat,  
  LONG cbFormat     
);

Parameters

ps

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 Values

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

**  Windows NT/2000/XP:** Included in Windows NT 3.1 and later.
**  Windows 95/98/Me:** Included in Windows 95 and later.
**  Header:** Declared in Vfw.h.
**  Library:** Use Vfw32.lib.

See Also

Custom File and Stream Handlers, Custom File and Stream Handler Interfaces, AVIStreamSetFormat, BITMAPINFOHEADER, WAVEFORMATEX