TPageRef Class Reference

#include <s32page.h>

class TPageRef

Detailed Description

Encapsulates a page reference.

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

Constructor & Destructor Documentation

TPageRef ( )

TPageRef()[inline]

Default constructor.

TPageRef ( TUint32 )

TPageRef(TUint32aValue)[inline]

Constructor that initialises the object to a page reference value.

Parameters
aValuePage reference value

Member Function Documentation

ExternalizeL ( RWriteStream & )

voidExternalizeL(RWriteStream &aStream)const [inline]

Externalises a TPageRef object to a write stream.

Parameters
aStreamStream to which the object should be externalised.

InternalizeL ( RReadStream & )

voidInternalizeL(RReadStream &aStream)[inline]

Internalises a TPageRef object from a read stream.

Parameters
aStreamStream from which the object should be internalised.

Value ( )

TUint32 Value()const [inline]

Gets the page reference value.

Return Value
Page reference value

operator!= ( TPageRef )

TBool operator!=(TPageRefaRef)const [inline]

Inequality operator.

Parameters
aRefPage reference against which to compare
Return Value
True if aRef does not refer to the same page as the object, otherwise false.

operator== ( TPageRef )

TBool operator==(TPageRefaRef)const [inline]

Equality operator.

Parameters
aRefPage reference against which to compare
Return Value
True if aRef refers to the same page as the object, otherwise false.