TStreamPos Class Reference

#include <s32buf.h>

class TStreamPos
Public Member Functions
TStreamPos()
TStreamPos(TInt)
TInt Offset()
TBool operator!=(TStreamPos)
TStreamPos operator+(TInt)
TStreamPos &operator+=(TInt)
TInt operator-(TStreamPos)
TStreamPos operator-(TInt)
TStreamPos &operator-=(TInt)
TBool operator<(TStreamPos)
TBool operator<=(TStreamPos)
TBool operator==(TStreamPos)
TBool operator>(TStreamPos)
TBool operator>=(TStreamPos)

Detailed Description

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.

See also: MStreamBuf::SeekL() MStreamBuf::TellL()

Constructor & Destructor Documentation

TStreamPos ( )

TStreamPos()[inline]

Constructs an empty stream position object.

TStreamPos ( TInt )

TStreamPos(TIntanOffset)[inline]

Constructs the stream position object from the specified value.

Parameters
anOffsetThe position value.

Member Function Documentation

Offset ( )

TInt Offset()const [inline]

Gets the stream position value.

Return Value
The stream position value.

operator!= ( TStreamPos )

TBool operator!=(TStreamPosaPos)const [inline]

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

Parameters
aPosThe stream position to be compared.
Return Value
True, if this object's stream position value is not equal to the specified stream position's value; false, otherwise.

operator+ ( TInt )

TStreamPos operator+(TIntanOffset)const [inline]

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

Parameters
anOffsetThe value to be added.
Return Value
The stream position object holding the result of the calculation.

operator+= ( TInt )

TStreamPos &operator+=(TIntanOffset)[inline]

Adds the specified value to this stream position object.

Parameters
anOffsetThe value to be added.
Return Value
A reference to this stream position object.

operator- ( TStreamPos )

TInt operator-(TStreamPosaPos)const [inline]

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

Parameters
aPosThe stream position whose value is to be subtracted.
Return Value
The result of the calculation.

operator- ( TInt )

TStreamPos operator-(TIntanOffset)const [inline]

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

Parameters
anOffsetThe value to be subtracted.
Return Value
The stream position object holding the result of the calculation.

operator-= ( TInt )

TStreamPos &operator-=(TIntanOffset)[inline]

Subtracts the specified value from this stream position object.

Parameters
anOffsetThe value to be subtracted.
Return Value
A reference to this stream position object.

operator< ( TStreamPos )

TBool operator<(TStreamPosaPos)const [inline]

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

Parameters
aPosThe stream position to be compared.
Return Value
True, if this object's stream position value is less than the specified stream position's value; false, otherwise.

operator<= ( TStreamPos )

TBool operator<=(TStreamPosaPos)const [inline]

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

Parameters
aPosThe stream position to be compared.
Return Value
True, if this object's stream position value is less than or equal to the specified stream position's value; false, otherwise.

operator== ( TStreamPos )

TBool operator==(TStreamPosaPos)const [inline]

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

Parameters
aPosThe stream position to be compared.
Return Value
True, if this object's stream position value is equal to the specified stream position's value; false, otherwise.

operator> ( TStreamPos )

TBool operator>(TStreamPosaPos)const [inline]

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

Parameters
aPosThe stream position to be compared.
Return Value
True, if this object's stream position value is greater than the specified stream position's value; false, otherwise.

operator>= ( TStreamPos )

TBool operator>=(TStreamPosaPos)const [inline]

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

Parameters
aPosThe stream position to be compared.
Return Value
True, if this object's stream position value is greater than or equal to the specified stream position's value; false, otherwise.
© Nokia 2005.