xflminterface IF_PosIStream : public IF_IStream


This class represents a positionable input stream object.  It extends IF_IStream.  An IF_PosIStream object may be obtained by invoking various methods on the IF_DbSystem object: openBufferIStream, openFileIStream, etc.  An application may also write its own implementation of the IF_PosIStream interface if it wants to pass data into various methods that take an IF_PosIStream object as a parameter.  The IF_PosIStream adds positioning methods to the IF_IStream object.


Method Summary

RCODE IF_IStream::read - Read data from this input stream.
FLMUINT totalSize - Return the total number of bytes available in this input stream.
FLMUINT remainingSize - Return the total number of bytes remaining to be read from this input stream.
RCODE positionTo - Position to a specific offset in the input stream.
FLMUINT getCurrPosition - Get the current offset we are positioned at in the input stream.

 

Method Detail

totalSize

    FLMUINT totalSize( void);

Return the total number of bytes available in this input stream.

    Parameters In: none

    Parameters Out: none

[Back to Top]


remainingSize

    FLMUINT remainingSize( void);

Return the total number of bytes remaining to be read from this input stream.  This will change as data is read from the stream, or as position within the stream is changed (see positionTo).

    Parameters In: none

    Parameters Out: none

[Back to Top]


positionTo

    RCODE positionTo(

        FLMUINT    uiPosition);

Position to the specified offset in the input stream.

    Parameters In:

FLMUINT uiPosition Offset to position to in the input stream.

    Parameters Out: none

[Back to Top]


getCurrPosition

    FLMUINT getCurrPosition( void);

Return the current offset we are positioned at in the input stream.

    Parameters In: none

    Parameters Out: none

[Back to Top]