AVIStreamReadData

The AVIStreamReadData function reads optional header data from a stream.

STDAPI AVIStreamReadData(
  PAVISTREAM pavi, 
  DWORD ckid,      
  LPVOID lpData,   
  LONG * lpcbData  
);
 

Parameters

pavi

Handle of an open stream.

ckid

Four-character code identifying the data.

lpData

Address of the buffer to contain the optional header data.

lpcbData

Address of the location that specifies the buffer size used for lpData. If the read is successful, AVIFile changes this value to indicate the amount of data written into the buffer for lpData.

Return Values

Returns zero if successful or an error otherwise. The return value AVIERR_NODATA indicates the system could not find any data with the specified chunk identifier.

Remarks

This function retrieves only optional header information from the stream. This information is custom and does not have a set format.

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

AVIFile Functions and Macros Overview, AVIFile Functions