Class TStreamPos

TStreamPos

Support

Supported from 5.0

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.

Defined in TStreamPos:
Offset(), TStreamPos(), operator!=(), operator+(), operator+=(), operator-(), operator-=(), operator<(), operator<=(), operator==(), operator>(), operator>=()

See also:

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

TStreamPos();

Description

Constructs an empty stream position object.

TStreamPos(TInt anOffset);

Description

Constructs the stream position object from the specified value.

Parameters

TInt anOffset The position value.

TInt Offset() const;

Description

Gets the stream position value.

Return value

TInt The stream position value.

TInt operator-(TStreamPos aPos) const;

Description

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.

Return value

TInt The result of the calculation.

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

TInt anOffset The value to be subtracted.

Return value

TStreamPos The stream position object holding the result of the calculation.

TStreamPos& operator-=(TInt anOffset);

Description

Subtracts the specified value from this stream position object.

Parameters

TInt anOffset The value to be subtracted.

Return value

TStreamPos& A reference to this stream position object.

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

TInt anOffset The value to be added.

Return value

TStreamPos The stream position object holding the result of the calculation.

TStreamPos& operator+=(TInt anOffset);

Description

Adds the specified value to this stream position object.

Parameters

TInt anOffset The value to be added.

Return value

TStreamPos& A reference to this stream position object.

TBool operator==(TStreamPos aPos) const;

Description

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

Parameters

TStreamPos aPos The stream position to be compared.

Return value

TBool True, if this object's stream position value is equal to the specified stream position's value; false, otherwise.

TBool operator!=(TStreamPos aPos) const;
    

Description

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

Parameters

TStreamPos aPos The stream position to be compared.

Return value

TBool True, if this object's stream position value is not equal to the specified stream position's value; false, otherwise.

TBool operator<(TStreamPos aPos) const;

Description

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

Parameters

TStreamPos aPos The stream position to be compared.

Return value

TBool True, if this object's stream position value is less than the specified stream position's value; false, otherwise.

TBool operator<=(TStreamPos aPos) const;

Description

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

Parameters

TStreamPos aPos The stream position to be compared.

Return value

TBool True, if this object's stream position value is less than or equal to the specified stream position's value; false, otherwise.

TBool operator>(TStreamPos aPos) const;

Description

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

Parameters

TStreamPos aPos The stream position to be compared.

Return value

TBool True, if this object's stream position value is greater than the specified stream position's value; false, otherwise.

TBool operator>=(TStreamPos aPos) const;

Description

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

Parameters

TStreamPos aPos The stream position to be compared.

Return value

TBool True, if this object's stream position value is greater than or equal to the specified stream position's value; false, otherwise.