Export (0) Print
Expand All

AVIStreamReadData

The AVIStreamReadData function reads optional header data from a stream.

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

Parameters

pavi

Handle to an open stream.

ckid

Four-character code identifying the data.

lpData

Pointer to the buffer to contain the optional header data.

lpcbData

Pointer to 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.

The argument pavi is a pointer to an IAVIStream interface.

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

AVIFile Functions and Macros, AVIFile Functions

Show:
© 2014 Microsoft