IAVIStream::SetFormat

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

Address of the interface to a stream.

lpFormat

Address of 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) 
 

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in vfw.h.
  Import Library: Use vfw32.lib.

See Also

Custom File and Stream Handlers Overview, Custom File and Stream Handler Interfaces, AVIStreamSetFormat, BITMAPINFOHEADER, PCMWAVEFORMAT