RChunk Class Reference

class RChunk : public RHandleBase

A handle to a chunk.

The chunk itself is a kernel side object.

Inherits from

Public Member Functions
IMPORT_C TIntAdjust(TInt)
IMPORT_C TIntAdjustDoubleEnded(TInt, TInt)
IMPORT_C TIntAllocate(TInt)
IMPORT_C TUint8 *Base()
IMPORT_C TIntBottom()
IMPORT_C TIntCommit(TInt, TInt)
IMPORT_C TIntCreate(TChunkCreateInfo &)
IMPORT_C TIntCreateDisconnectedGlobal(const TDesC &, TInt, TInt, TInt, TOwnerType)
IMPORT_C TIntCreateDisconnectedLocal(TInt, TInt, TInt, TOwnerType)
IMPORT_C TIntCreateDoubleEndedGlobal(const TDesC &, TInt, TInt, TInt, TOwnerType)
IMPORT_C TIntCreateDoubleEndedLocal(TInt, TInt, TInt, TOwnerType)
IMPORT_C TIntCreateGlobal(const TDesC &, TInt, TInt, TOwnerType)
IMPORT_C TIntCreateLocal(TInt, TInt, TOwnerType)
IMPORT_C TIntCreateLocalCode(TInt, TInt, TOwnerType)
IMPORT_C TIntDecommit(TInt, TInt)
IMPORT_C TBoolIsPaged()
TBool IsReadable()
TBool IsWritable()
IMPORT_C TIntLock(TInt, TInt)
IMPORT_C TIntMaxSize()
TInt Open(const TFindChunk &, TOwnerType)
IMPORT_C TIntOpen(RMessagePtr2, TInt, TBool, TOwnerType)
IMPORT_C TIntOpen(TInt, TOwnerType)
IMPORT_C TIntOpenGlobal(const TDesC &, TBool, TOwnerType)
IMPORT_C TIntSetRestrictions(TUint)
IMPORT_C TIntSize()
IMPORT_C TIntTop()
IMPORT_C TIntUnlock(TInt, TInt)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::Close()
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RHandleBase::SetReturnedHandle(TInt)
RHandleBase::SetReturnedHandle(TInt,RHandleBase &)
Public Member Enumerations
enumTRestrictions { EPreventAdjust = 0x01 }
Inherited Enumerations
RHandleBase:TAttributes
Inherited Attributes
RHandleBase::iHandle

Member Functions Documentation

Adjust(TInt)

IMPORT_C TIntAdjust(TIntaNewSize)const

Parameters

TInt aNewSize

AdjustDoubleEnded(TInt, TInt)

IMPORT_C TIntAdjustDoubleEnded(TIntaBottom,
TIntaTop
)const

Parameters

TInt aBottom
TInt aTop

Allocate(TInt)

IMPORT_C TIntAllocate(TIntaSize)const

Parameters

TInt aSize

Base()

IMPORT_C TUint8 *Base()const

Bottom()

IMPORT_C TIntBottom()const

Commit(TInt, TInt)

IMPORT_C TIntCommit(TIntanOffset,
TIntaSize
)const

Parameters

TInt anOffset
TInt aSize

Create(TChunkCreateInfo &)

IMPORT_C TIntCreate(TChunkCreateInfo &aCreateInfo)

Parameters

TChunkCreateInfo & aCreateInfo

CreateDisconnectedGlobal(const TDesC &, TInt, TInt, TInt, TOwnerType)

IMPORT_C TIntCreateDisconnectedGlobal(const TDesC &aName,
TIntaInitialBottom,
TIntaInitialTop,
TIntaMaxSize,
TOwnerTypeaType = EOwnerProcess
)

Parameters

const TDesC & aName
TInt aInitialBottom
TInt aInitialTop
TInt aMaxSize
TOwnerType aType = EOwnerProcess

CreateDisconnectedLocal(TInt, TInt, TInt, TOwnerType)

IMPORT_C TIntCreateDisconnectedLocal(TIntaInitialBottom,
TIntaInitialTop,
TIntaMaxSize,
TOwnerTypeaType = EOwnerProcess
)

Parameters

TInt aInitialBottom
TInt aInitialTop
TInt aMaxSize
TOwnerType aType = EOwnerProcess

CreateDoubleEndedGlobal(const TDesC &, TInt, TInt, TInt, TOwnerType)

IMPORT_C TIntCreateDoubleEndedGlobal(const TDesC &aName,
TIntaInitialBottom,
TIntaInitialTop,
TIntaMaxSize,
TOwnerTypeaType = EOwnerProcess
)

Parameters

const TDesC & aName
TInt aInitialBottom
TInt aInitialTop
TInt aMaxSize
TOwnerType aType = EOwnerProcess

CreateDoubleEndedLocal(TInt, TInt, TInt, TOwnerType)

IMPORT_C TIntCreateDoubleEndedLocal(TIntaInitialBottom,
TIntaInitialTop,
TIntaMaxSize,
TOwnerTypeaType = EOwnerProcess
)

Parameters

TInt aInitialBottom
TInt aInitialTop
TInt aMaxSize
TOwnerType aType = EOwnerProcess

CreateGlobal(const TDesC &, TInt, TInt, TOwnerType)

IMPORT_C TIntCreateGlobal(const TDesC &aName,
TIntaSize,
TIntaMaxSize,
TOwnerTypeaType = EOwnerProcess
)

Parameters

const TDesC & aName
TInt aSize
TInt aMaxSize
TOwnerType aType = EOwnerProcess

CreateLocal(TInt, TInt, TOwnerType)

IMPORT_C TIntCreateLocal(TIntaSize,
TIntaMaxSize,
TOwnerTypeaType = EOwnerProcess
)

Parameters

TInt aSize
TInt aMaxSize
TOwnerType aType = EOwnerProcess

CreateLocalCode(TInt, TInt, TOwnerType)

IMPORT_C TIntCreateLocalCode(TIntaSize,
TIntaMaxSize,
TOwnerTypeaType = EOwnerProcess
)

Parameters

TInt aSize
TInt aMaxSize
TOwnerType aType = EOwnerProcess

Decommit(TInt, TInt)

IMPORT_C TIntDecommit(TIntanOffset,
TIntaSize
)const

Parameters

TInt anOffset
TInt aSize

IsPaged()

IMPORT_C TBoolIsPaged()const

IsReadable()

TBool IsReadable()const [inline]

Tests whether the chunk is mapped into its process address space.

True, if the chunk is readable; false, otherwise.

IsWritable()

TBool IsWritable()const [inline]

Tests whether the chunk mapped into its process address space and is writable.

True, if the chunk is writable; false, otherwise.

Lock(TInt, TInt)

IMPORT_C TIntLock(TIntaOffset,
TIntaSize
)

Parameters

TInt aOffset
TInt aSize

MaxSize()

IMPORT_C TIntMaxSize()const

Open(const TFindChunk &, TOwnerType)

TInt Open(const TFindChunk &aFind,
TOwnerTypeaType = EOwnerProcess
)[inline]

Opens a handle to the global chunk found using a TFindChunk object.

A TFindChunk object is used to find all chunks whose full names match a specified pattern.

By default, ownership of this chunk handle is vested in the current process, but can be vested in the current thread by passing EOwnerThread as the second parameter to this function.

KErrNone if successful, otherwise another of the system error codes.

Parameters

const TFindChunk & aFindA reference to the TFindChunk object used to find the chunk.
TOwnerType aType = EOwnerProcessAn enumeration whose enumerators define the ownership of this chunk handle. If not explicitly specified, EOwnerProcess is taken as default.

Open(RMessagePtr2, TInt, TBool, TOwnerType)

IMPORT_C TIntOpen(RMessagePtr2aMessage,
TIntaParam,
TBoolisReadOnly,
TOwnerTypeaType = EOwnerProcess
)

Parameters

RMessagePtr2 aMessage
TInt aParam
TBool isReadOnly
TOwnerType aType = EOwnerProcess

Open(TInt, TOwnerType)

IMPORT_C TIntOpen(TIntaArgumentIndex,
TOwnerTypeaType = EOwnerProcess
)

Parameters

TInt aArgumentIndex
TOwnerType aType = EOwnerProcess

OpenGlobal(const TDesC &, TBool, TOwnerType)

IMPORT_C TIntOpenGlobal(const TDesC &aName,
TBoolisReadOnly,
TOwnerTypeaType = EOwnerProcess
)

Parameters

const TDesC & aName
TBool isReadOnly
TOwnerType aType = EOwnerProcess

SetRestrictions(TUint)

IMPORT_C TIntSetRestrictions(TUintaFlags)

Parameters

TUint aFlags

Size()

IMPORT_C TIntSize()const

Top()

IMPORT_C TIntTop()const

Unlock(TInt, TInt)

IMPORT_C TIntUnlock(TIntaOffset,
TIntaSize
)

Parameters

TInt aOffset
TInt aSize

Member Enumerations Documentation

Enum TRestrictions

Enumerators

EPreventAdjust = 0x01

Prevent Adjust, Commit, Allocate and Decommit

© Nokia 2010.