summaryrefslogtreecommitdiff
path: root/docs/common/lib_common/CollectInBufferStream.txt
blob: 5f9556a3b3d96092caff96cc22870dd1e76726c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
CLASS CollectInBufferStream

This class is essentially a buffer. Data is written to it, and stored in memory. Then when all data is written which will be written, it can be read out again.

Useful for building streams in memory.


FUNCTION CollectInBufferStream::SetForReading()

After you've written all the data, call this to set it to read mode.


FUNCTION CollectInBufferStream::Reset()

Reset the stream to the state where is has no data, and is about to have data written.


FUNCTION CollectInBufferStream::GetSize()

Get the size of the buffered data -- the entire data. Use the interface function BytesLeftToRead() in most cases. 


FUNCTION CollectInBufferStream::GetBuffer()

Get the buffer, so you can do bad things with it if you're feeling naughty.