Game Accessibility Library logo SourceForge.net Logo
Game Accessibility Suite: CATStream::CreateSubStream
CATStream * CATStream::CreateSubStream ( CATInt64  streamOffset,
CATInt64  streamLength,
CATSUBSTREAMBUILDER  builder = CATStream::DefSubStreamBuilder,
void *  param1 = 0,
CATUInt32  param2 = 0 
) [virtual]

CreateSubStream() creates a substream that uses this stream for I/O at a specified offset and length.

You must call ReleaseSubStream() when you are done with the substream.

Parameters:
streamOffset - offset within the stream that should be the start of the substream. This is an absolute position, and is not related to the stream's current position.
streamLength - length of the substream. If set to -1, it will use the entire length of the parent stream.
builder - substream builder for specialized substream types
param1 - void*, meaning depends on substream type
param2 - CATUInt32, meaning depends on substream type
Returns:
CATStream* - ptr to new stream or null on failure
See also:
ReleaseSubStream()

Definition at line 39 of file CATStream.cpp.

References CAT_SUCCESS, CATASSERT, CATFAILED, fSubCount, and IsOpen().


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