Class TStreamPos

class TStreamPos;

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(TMark,TStreamPos) or MStreamBuf::TellL(TRead)const; they allow a program to remember the current read position in a stream buffer and reset it to the same location later.

Members

Defined in TStreamPos:

• Offset()constGets the stream position value.
• TStreamPos()Constructs an empty stream position object.
• TStreamPos(TInt)Constructs the stream position object from the specified value.
• operator!=(TStreamPos)constTests whether the stream position is not equal to the specified stream position.
• operator>(TStreamPos)constTests whether the stream position is greater than the specified stream position.
• operator>=(TStreamPos)constTests whether the stream position is greater than or equal to the specified stre...
• operator<(TStreamPos)constTests whether the stream position is less than the specified stream position.
• operator<=(TStreamPos)constTests whether the stream position is less than or equal to the specified stream ...
• operator+(TInt)constGets a stream position object that holds the result of adding the specified valu...
• operator+=(TInt)Adds the specified value to this stream position object.
• operator-(TInt)constGets a stream position object that holds the result of subtracting the specified...
• operator-(TStreamPos)constGets the result of subtracting the specified stream position value from this obj...
• operator-=(TInt)Subtracts the specified value from this stream position object.
• operator==(TStreamPos)constTests whether the stream position is equal to the specified stream position.

See also:

• MStreamBuf::SeekL(TMark,TStreamPos)Moves the position of the read or write mark in the stream.
• MStreamBuf::TellL(TRead)constGets the position of the read mark within the stream.

inline TStreamPos();

Description

Constructs an empty stream position object.

inline TStreamPos(TInt anOffset);

Description

Constructs the stream position object from the specified value.

Parameters

inline TBool operator==(TStreamPos aPos) const;

Description

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

Parameters

Return value

inline TBool operator!=(TStreamPos aPos) const;

Description

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

Parameters

Return value

inline TBool operator<(TStreamPos aPos) const;

Description

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

Parameters

Return value

inline TBool operator<=(TStreamPos aPos) const;

Description

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

Parameters

Return value

inline TBool operator>(TStreamPos aPos) const;

Description

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

Parameters

Return value

inline TBool operator>=(TStreamPos aPos) const;

Description

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

Parameters

Return value

inline TInt operator-(TStreamPos aPos) const;

Description

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

Parameters

Return value

inline TStreamPos operator+(TInt anOffset) const;

Description

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

Parameters

Return value

inline TStreamPos operator-(TInt anOffset) const;

Description

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

Parameters

Return value

inline TStreamPos& operator+=(TInt anOffset);

Description

Adds the specified value to this stream position object.

Parameters

Return value

inline TStreamPos& operator-=(TInt anOffset);

Description

Subtracts the specified value from this stream position object.

Parameters

Return value

inline TInt Offset() const;

Description

Gets the stream position value.

Return value