TStreamPos Class Reference

class TStreamPos

Holds the position of the read or write mark within a seekable stream.

Position is the offset from the beginning of a seekable stream. The class provides convenient operators for performing arithmetic on the offset value and for doing comparisons between stream position objects.

It can be considered as an absolute stream position.

Objects of this type are usually created as a result of calling MStreamBuf::SeekL() or MStreamBuf::TellL() ; they allow a program to remember the current read position in a stream buffer and reset it to the same location later.

MStreamBuf::SeekL() MStreamBuf::TellL()

Constructor & Destructor Documentation

TStreamPos()

TStreamPos ( ) [inline]

Constructs an empty stream position object.

TStreamPos(TInt)

TStreamPos ( TInt anOffset ) [inline]

Constructs the stream position object from the specified value.

Parameters

TInt anOffset The position value.

Member Functions Documentation

Offset()

TInt Offset ( ) const [inline]

Gets the stream position value.

operator!=(TStreamPos)

TBool operator!= ( TStreamPos aPos ) const [inline]

Tests whether the stream position is not equal to the specified stream position.

Parameters

TStreamPos aPos The stream position to be compared.

operator+(TInt)

TStreamPos operator+ ( TInt anOffset ) const [inline]

Gets a stream position object that holds the result of adding the specified value to this object's stream position value.

Parameters

TInt anOffset The value to be added.

operator+=(TInt)

TStreamPos & operator+= ( TInt anOffset ) [inline]

Adds the specified value to this stream position object.

Parameters

TInt anOffset The value to be added.

operator-(TStreamPos)

TInt operator- ( TStreamPos aPos ) const [inline]

Gets the result of subtracting the specified stream position value from this object's stream position value.

Parameters

TStreamPos aPos The stream position whose value is to be subtracted.

operator-(TInt)

TStreamPos operator- ( TInt anOffset ) const [inline]

Gets a stream position object that holds the result of subtracting the specified value from this object's stream position value.

Parameters

TInt anOffset The value to be subtracted.

operator-=(TInt)

TStreamPos & operator-= ( TInt anOffset ) [inline]

Subtracts the specified value from this stream position object.

Parameters

TInt anOffset The value to be subtracted.

operator<(TStreamPos)

TBool operator< ( TStreamPos aPos ) const [inline]

Tests whether the stream position is less than the specified stream position.

Parameters

TStreamPos aPos The stream position to be compared.

operator<=(TStreamPos)

TBool operator<= ( TStreamPos aPos ) const [inline]

Tests whether the stream position is less than or equal to the specified stream position.

Parameters

TStreamPos aPos The stream position to be compared.

operator==(TStreamPos)

TBool operator== ( TStreamPos aPos ) const [inline]

Tests whether the stream position is equal to the specified stream position.

Parameters

TStreamPos aPos The stream position to be compared.

operator>(TStreamPos)

TBool operator> ( TStreamPos aPos ) const [inline]

Tests whether the stream position is greater than the specified stream position.

Parameters

TStreamPos aPos The stream position to be compared.

operator>=(TStreamPos)

TBool operator>= ( TStreamPos aPos ) const [inline]

Tests whether the stream position is greater than or equal to the specified stream position.

Parameters

TStreamPos aPos The stream position to be compared.

Member Data Documentation

TInt iOff

TInt iOff [private]