This structure specifies the type and properties of the chunk to be created. More...

#include <e32std.h>

Public Types
enum	TChunkCreateVersions { EVersion0 , ESupportedVersions }

enum	TChunkPagingAtt { EUnspecified , EPaged , EUnpaged }
	Attributes that specify whether the chunk to be created is data paged or not. More...

Public Member Functions
IMPORT_C	TChunkCreateInfo ()
	Default constructor.

IMPORT_C void	SetNormal (TInt aInitialSize, TInt aMaxSize)
	Sets the chunk to be created to have a committed region that always starts at the bottom of the reserved region.

IMPORT_C void	SetCode (TInt aInitialSize, TInt aMaxSize)
	Sets the chunk to be created to be user writable and to be marked by the kernel as containing code.

IMPORT_C void	SetDoubleEnded (TInt aInitialBottom, TInt aInitialTop, TInt aMaxSize)
	Sets the chunk to be created to have a commited region that that can be any contiguous subset of the reserved region.

IMPORT_C void	SetDisconnected (TInt aInitialBottom, TInt aInitialTop, TInt aMaxSize)
	Set the chunk to be created to have a committed region consisting of an arbitrary set of MMU pages within the reserved region.

IMPORT_C void	SetOwner (TOwnerType aType)
	Sets the owner of the chunk to be created.

IMPORT_C void	SetGlobal (const TDesC &aName)
	Sets the chunk to be created to be global, i.e.

IMPORT_C void	SetClearByte (TUint8 aClearByte)
	Sets the byte value that all memory committed to the chunk will be cleared to.

IMPORT_C void	SetPaging (const TChunkPagingAtt aPaging)
	Sets the data paging attributes for the chunk to be created.

IMPORT_C void	SetReadOnly ()
	Sets the global chunk to be created to be read only.

void	SetThreadHeap (TInt aInitialSize, TInt aMaxSize, const TDesC &aName)
	Sets the chunk to be created to be a thread heap chunk.

IMPORT_C void	SetCache (TInt aMaxSize)

Protected Attributes
TUint	iVersionNumber
	The version number of this TChunkCreateInfo.

TUint	iType
	The type of the chunk to be created.

TBool	iGlobal
	Specify if chunk is global or not.

TInt	iMaxSize
	The maximum size in bytes of the chunk to be created.

TOwnerType	iOwnerType
	An enumeration whose enumerators define the ownership of this chunk handle.

const TDesC *	iName
	A pointer to a descriptor containing the name to be assigned to global chunks.

TInt	iInitialBottom
	The offset of the bottom of the region to commit to the chunk on creation from the base of the chunk's reserved region.

TInt	iInitialTop
	The offset of the top of the region to commit to the chunk on creation from the base of the chunk's reserved region.

TUint	iAttributes
	Attributes to the chunk to be created should have.

TUint8	iClearByte
	The byte to clear all the memory committed to the chunk to.

TUint8	iSpare1 [3]

TUint	iSpare2

Friends
class	RChunk

Detailed Description

This structure specifies the type and properties of the chunk to be created.

It is passed as a parameter to the RChunk::Create() method.

API status: Published to all clients. Released API.

Definition at line 3618 of file e32std.h.

Member Enumeration Documentation

◆ TChunkCreateVersions

enum TChunkCreateInfo::TChunkCreateVersions

Currently supported version numbers

API status: Internal component API.

Enumerator
EVersion0
ESupportedVersions

Definition at line 3627 of file e32std.h.

◆ TChunkPagingAtt

enum TChunkCreateInfo::TChunkPagingAtt

Attributes that specify whether the chunk to be created is data paged or not.

Enumerator
EUnspecified	The chunk will use the creating process's paging attributes.
EPaged	The chunk will be data paged.
EUnpaged	The chunk will not be data paged.

Definition at line 3638 of file e32std.h.

Constructor & Destructor Documentation

◆ TChunkCreateInfo()

IMPORT_C TChunkCreateInfo::TChunkCreateInfo ( )

Default constructor.

This defaults the chunk to be created to be local, to have no attributes set and to use the default clear byte.

A local chunk is private to the process creating it and is not intended for access by other user processes.

(generated from Symbian Developer Library)

Member Function Documentation

◆ SetCache()

IMPORT_C void TChunkCreateInfo::SetCache ( TInt aMaxSize )

For use by file server only.

API status: Internal technology API.

◆ SetClearByte()

IMPORT_C void TChunkCreateInfo::SetClearByte ( TUint8 aClearByte )

Sets the byte value that all memory committed to the chunk will be cleared to.

(generated from Symbian Developer Library)

◆ SetCode()

IMPORT_C void TChunkCreateInfo::SetCode	(	TInt	aInitialSize,
		TInt	aMaxSize
	)

Sets the chunk to be created to be user writable and to be marked by the kernel as containing code.

This can only be set on local chunks.

RChunk::CreateLocalCode()

Parameters

aInitialSize	The number of bytes committed to this chunk.
aMaxSize	The maximum size to which the reserved region of this chunk can grow.

(generated from Symbian Developer Library)

◆ SetDisconnected()

IMPORT_C void TChunkCreateInfo::SetDisconnected	(	TInt	aInitialBottom,
		TInt	aInitialTop,
		TInt	aMaxSize
	)

Set the chunk to be created to have a committed region consisting of an arbitrary set of MMU pages within the reserved region.

RChunk::CreateDisconnectedLocal()

Parameters

aInitialBottom	The offset of the bottom of the new committed region from the base of the chunk's reserved region.
aInitialTop	The offset of the top of the new committed region from the base of the chunk's reserved region.
aMaxSize	The maximum size to which the reserved region of this chunk can grow.

(generated from Symbian Developer Library)

◆ SetDoubleEnded()

IMPORT_C void TChunkCreateInfo::SetDoubleEnded	(	TInt	aInitialBottom,
		TInt	aInitialTop,
		TInt	aMaxSize
	)

Sets the chunk to be created to have a commited region that that can be any contiguous subset of the reserved region.

RChunk::CreateDoubleEndedLocal()

Parameters

aInitialBottom	The offset of the bottom of the new committed region from the base of the chunk's reserved region.
aInitialTop	The offset of the top of the new committed region from the base of the chunk's reserved region.
aMaxSize	The maximum size to which the reserved region of this chunk can grow.

(generated from Symbian Developer Library)

◆ SetGlobal()

IMPORT_C void TChunkCreateInfo::SetGlobal ( const TDesC & aName )

Sets the chunk to be created to be global, i.e.

it is potentially visible to all processes and is intended for access by other user processes.

Parameters

aName A reference to a descriptor containing the name to be assigned to the global chunk. The length of the descriptor must be no greater than that allowed for a TKName type.

(generated from Symbian Developer Library)

◆ SetNormal()

IMPORT_C void TChunkCreateInfo::SetNormal	(	TInt	aInitialSize,
		TInt	aMaxSize
	)

Sets the chunk to be created to have a committed region that always starts at the bottom of the reserved region.

RChunk::CreateLocal()

Parameters

aInitialSize	The initial number of bytes committed at the bottom of the chunk.
aMaxSize	The maximum size to which the reserved region of this chunk can grow.

(generated from Symbian Developer Library)

◆ SetOwner()

IMPORT_C void TChunkCreateInfo::SetOwner ( TOwnerType aType )

Sets the owner of the chunk to be created.

Parameters

aType The owner of the chunk to be created.

(generated from Symbian Developer Library)

◆ SetPaging()

IMPORT_C void TChunkCreateInfo::SetPaging ( const TChunkPagingAtt aPaging )

Sets the data paging attributes for the chunk to be created.

Any previous calls to this method will be overridden for this TChunkCreateInfo object.

Parameters

aPaging The data paging attributes of the chunk to be created.

(generated from Symbian Developer Library)

◆ SetReadOnly()

IMPORT_C void TChunkCreateInfo::SetReadOnly ( )

Sets the global chunk to be created to be read only.

Only the creating process will be able to write to it, not other processes.

Read-Only chunks are currently only available on the Flexible Memory Model.

Chunk must be global.

(generated from Symbian Developer Library)

◆ SetThreadHeap()

void TChunkCreateInfo::SetThreadHeap	(	TInt	aInitialSize,
		TInt	aMaxSize,
		const TDesC &	aName
	)

Sets the chunk to be created to be a thread heap chunk.

For internal use only.

Parameters

aInitialSize	The number of bytes committed to this chunk.
aMaxSize	The maximum size to which the reserved region of this chunk can grow.
aName	The name to be given to the chunk to be created

(generated from Symbian Developer Library)

Friends And Related Symbol Documentation

◆ RChunk

friend class RChunk

friend

Definition at line 3633 of file e32std.h.

Member Data Documentation

◆ iAttributes

TUint TChunkCreateInfo::iAttributes

protected

Attributes to the chunk to be created should have.

Should be set from one or more the values in TChunkCreate::TChunkCreateAtt.

API status: Internal component API.

Definition at line 3726 of file e32std.h.

◆ iClearByte

TUint8 TChunkCreateInfo::iClearByte

protected

The byte to clear all the memory committed to the chunk to.

API status: Internal component API.

Definition at line 3732 of file e32std.h.

◆ iGlobal

TBool TChunkCreateInfo::iGlobal

protected

Specify if chunk is global or not.

API status: Internal component API.

Definition at line 3682 of file e32std.h.

◆ iInitialBottom

TInt TChunkCreateInfo::iInitialBottom

protected

The offset of the bottom of the region to commit to the chunk on creation from the base of the chunk's reserved region.

This is only used for double ended and disconnected chunks.

API status: Internal component API.

Definition at line 3711 of file e32std.h.

◆ iInitialTop

TInt TChunkCreateInfo::iInitialTop

protected

The offset of the top of the region to commit to the chunk on creation from the base of the chunk's reserved region.

This is only used for double ended and disconnected chunks.

API status: Internal component API.

Definition at line 3719 of file e32std.h.

◆ iMaxSize

TInt TChunkCreateInfo::iMaxSize

protected

The maximum size in bytes of the chunk to be created.

API status: Internal component API.

Definition at line 3688 of file e32std.h.

◆ iName

const TDesC* TChunkCreateInfo::iName

protected

A pointer to a descriptor containing the name to be assigned to
global chunks.

The length of the descriptor must be no greater than that allowed for a TKName type. Must be NULL for local chunks.

API status: Internal component API.

Definition at line 3703 of file e32std.h.

◆ iOwnerType

TOwnerType TChunkCreateInfo::iOwnerType

protected

An enumeration whose enumerators define the ownership of this chunk handle.

If not explicitly specified, EOwnerProcess is taken as default.

API status: Internal component API.

Definition at line 3695 of file e32std.h.

◆ iSpare1

TUint8 TChunkCreateInfo::iSpare1[3]

protected

API status: Internal component API.

Definition at line 3738 of file e32std.h.

◆ iSpare2

TUint TChunkCreateInfo::iSpare2

protected

API status: Internal component API.

Definition at line 3744 of file e32std.h.

◆ iType

TUint TChunkCreateInfo::iType

protected

The type of the chunk to be created.

API status: Internal component API.

Definition at line 3676 of file e32std.h.

◆ iVersionNumber

TUint TChunkCreateInfo::iVersionNumber

protected

The version number of this TChunkCreateInfo.

API status: Internal component API.

Definition at line 3670 of file e32std.h.

The documentation for this struct was generated from the following files:

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ TChunkCreateVersions

◆ TChunkPagingAtt

Constructor & Destructor Documentation

◆ TChunkCreateInfo()

Member Function Documentation

◆ SetCache()

◆ SetClearByte()

◆ SetCode()

◆ SetDisconnected()

◆ SetDoubleEnded()

◆ SetGlobal()

◆ SetNormal()

◆ SetOwner()

◆ SetPaging()

◆ SetReadOnly()

◆ SetThreadHeap()

Friends And Related Symbol Documentation

◆ RChunk

Member Data Documentation

◆ iAttributes

◆ iClearByte

◆ iGlobal

◆ iInitialBottom

◆ iInitialTop

◆ iMaxSize

◆ iName

◆ iOwnerType

◆ iSpare1

◆ iSpare2

◆ iType

◆ iVersionNumber