FDO API Reference Feature Data Objects

template<typename T>
virtual FDO_API_COMMON FdoInt32 FdoIoObjectStreamReader< T >::ReadNext T *  buffer,
const FdoInt32  offset = 0,
const FdoInt32  count = -1
[inline, virtual]
 

Reads in the next block of items. Use ReadNext( buffer) to read in the entire stream. The caller is responsible to allocate a buffer large enough to store data.

Parameters:
buffer Output array holding data read in.
offset Input index in the array indicating the beginning of the output buffer. If zero, then the buffer is reused. If the end of the buffer, then read in appending mode. Throws "out-of-bounds" exception if not in this range.
count Input number of items to be read in. If -1 read the entire stream. Throws "out-of-bounds" exception if not a positive value or -1.
Returns:
Returns the number of items actually read in. When 0 (zero) then the end-of-stream was reached.
If the stream provides context information then calculate how many items are left to read.

Items that will be read is lessor of items to read and items remaining. This ensures that we don't read any partial item at the end of the stream.

Implements FdoIStreamReaderTmpl< T >.

Definition at line 112 of file ObjectStreamReader.h.

Referenced by FdoIoObjectStreamReader< FdoByte >::ReadNext().


Comments or suggestions? Send us feedback.