Game Accessibility Library logo SourceForge.net Logo
Game Accessibility Suite: CATStream::Read
virtual CATResult CATStream::Read ( void *  buffer,
CATUInt32 length 
) [pure virtual]

Read() reads the requested amount of data into a buffer.

Will read up to, but not necessarily, [length] bytes. On return, length is set to the number of bytes actually read. buffer *must* be large enough for max value of length.

Parameters:
buffer - target buffer for read
length - min(length of buffer, desired read length). Set to amount read on return.
Returns:
CATResult - CAT_SUCCESS on success
See also:
Write()

Implemented in CATStreamFile, CATStreamRAM, and CATStreamSub.

Referenced by CATXMLParser::ParseStream(), and CATImage::PNGRead().


Generated on Mon Feb 11 04:10:55 2008 for Game Accessibility Suite by doxygen 1.5.4