#include <S32PAGE.H>

Class `TPageRef`

class TPageRef;

Description

Encapsulates a page reference.

A page reference is an integer value that can be used to identify a page.

Members

Defined in TPageRef:

ExternalizeL(RWriteStream &)constExternalises a TPageRef object to a write stream.
InternalizeL(RReadStream &)Internalises a TPageRef object from a read stream.
TPageRef()Default constructor.
TPageRef(TUint32)Constructor that initialises the object to a page reference value.
Value()constGets the page reference value.
operator!=(TPageRef)constInequality operator.
operator==(TPageRef)constEquality operator.

Construction and destruction

`TPageRef()`

inline TPageRef();

Description

Default constructor.

`TPageRef(TUint32)`

inline TPageRef(TUint32 aValue);

Description

Constructor that initialises the object to a page reference value.

Parameters


                                 						TUint32 aValue

Page reference value

Member functions

`operator==(TPageRef)const`

inline TBool operator==(TPageRef aRef) const;

Description

Equality operator.

Parameters


                                 						TPageRef aRef

Page reference against which to compare

Return value


                                 						TBool

True if aRef refers to the same page as the object, otherwise false.

`operator!=(TPageRef)const`

inline TBool operator!=(TPageRef aRef) const;

Description

Inequality operator.

Parameters


                                 						TPageRef aRef

Page reference against which to compare

Return value


                                 						TBool

True if aRef does not refer to the same page as the object, otherwise false.

`ExternalizeL(RWriteStream &)const`

inline void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises a TPageRef object to a write stream.

Parameters


                                 						RWriteStream &aStream

Stream to which the object should be externalised.

`InternalizeL(RReadStream &)`

inline void InternalizeL(RReadStream &aStream);

Description

Internalises a TPageRef object from a read stream.

Parameters


                                 						RReadStream &aStream

Stream from which the object should be internalised.

`Value()const`

inline TUint32 Value() const;

Description

Gets the page reference value.

Return value


                                 						TUint32

Page reference value

Class TPageRef

Description

Members

Construction and destruction

TPageRef()

Description

TPageRef(TUint32)

Description

Parameters

Member functions

operator==(TPageRef)const

Description

Parameters

Return value

operator!=(TPageRef)const

Description

Parameters

Return value

ExternalizeL(RWriteStream &)const

Description

Parameters

InternalizeL(RReadStream &)

Description

Parameters

Value()const

Description

Return value

Class `TPageRef`

`TPageRef()`

`TPageRef(TUint32)`

`operator==(TPageRef)const`

`operator!=(TPageRef)const`

`ExternalizeL(RWriteStream &)const`

`InternalizeL(RReadStream &)`

`Value()const`