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

#include <e32std.h>

Public Types
enum	TChunkHeapCreateVersions { EVersion0 , ESupportedVersions }

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

Public Member Functions
IMPORT_C	TChunkHeapCreateInfo (TInt aMinLength, TInt aMaxLength)
	Constructor where minimum and maximum length of the heap can be defined.

IMPORT_C void	SetCreateChunk (const TDesC *aName)
	Sets the chunk heap to create a new chunk with the specified name.

IMPORT_C void	SetUseChunk (const RChunk aChunk)
	Sets the chunk heap to be created to use the chunk specified.

void	SetSingleThread (TBool aSingleThread)
	Sets single thread property of the chunk heap.

void	SetAlignment (TInt aAlign)
	Sets alignment of the cells of the chunk heap to be created.

void	SetGrowBy (TInt aGrowBy)
	Sets the increments to the size of the host chunk.

void	SetOffset (TInt aOffset)
	Sets the offset from the base of the host chunk to the start of the heap.

void	SetMode (TUint aMode)
	Sets the mode flags of the chunk heap.

void	SetPaging (const TChunkHeapPagingAtt aPaging)
	Sets the paging attribute of the chunk heap to be created.

Protected Attributes
TUint	iVersionNumber
	The version number of this TChunkHeapCreateInfo.

TInt	iMinLength
	The minimum size for the heap.

TInt	iMaxLength
	The maximum size for the heap.

TInt	iAlign
	The alignment of the heap.

TInt	iGrowBy
	The grow by value of the heap.

TBool	iSingleThread
	The single thread value of the heap.

TInt	iOffset
	The offset from the base of the chunk to the start of the heap.

TChunkHeapPagingAtt	iPaging
	The paging attributes of the chunk.

TUint	iMode
	The mode flags for the heap.

TDesC *	iName
	The name of the chunk to be created for the heap.

RChunk	iChunk
	The chunk to use for the heap.

TInt	iSpare [5]

Friends
class	UserHeap

Detailed Description

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

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

API status: Published to all clients. Released API.

Definition at line 3755 of file e32std.h.

Member Enumeration Documentation

◆ TChunkHeapCreateVersions

enum TChunkHeapCreateInfo::TChunkHeapCreateVersions

Currently supported version numbers

API status: Internal component API.

Enumerator
EVersion0
ESupportedVersions

Definition at line 3764 of file e32std.h.

◆ TChunkHeapPagingAtt

enum TChunkHeapCreateInfo::TChunkHeapPagingAtt

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

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

Definition at line 3773 of file e32std.h.

Constructor & Destructor Documentation

◆ TChunkHeapCreateInfo()

IMPORT_C TChunkHeapCreateInfo::TChunkHeapCreateInfo	(	TInt	aMinLength,
		TInt	aMaxLength
	)

Constructor where minimum and maximum length of the heap can be defined.

It defaults the chunk heap to be created to have use a new local chunk, to have a grow by value of KMinHeapGrowBy, to be unaligned, not to be single threaded and not to have any mode flags set.

Parameters

aMinLength	The minimum length of the heap to be created.
aMaxLength	The maximum length to which the heap to be created can grow. If the supplied value is less than KMinHeapSize, then it is discarded and the value KMinHeapSize used instead.

(generated from Symbian Developer Library)

Member Function Documentation

◆ SetAlignment()

void TChunkHeapCreateInfo::SetAlignment ( TInt aAlign )

inline

Sets alignment of the cells of the chunk heap to be created.

This overrides any previous call to TChunkHeapCreateInfo::SetAlignment() for this TChunkHeapCreateInfo object.

(generated from Symbian Developer Library)

◆ SetCreateChunk()

IMPORT_C void TChunkHeapCreateInfo::SetCreateChunk ( const TDesC * aName )

Sets the chunk heap to create a new chunk with the specified name.

This overriddes any previous call to TChunkHeapCreateInfo::SetNewChunkHeap() or TChunkHeapCreateInfo::SetExistingChunkHeap() for this TChunkHeapCreateInfo object.

Parameters

aName The name to be given to the chunk heap to be created If NULL, the function constructs a local chunk to host the heap. If not NULL, a pointer to a descriptor containing the name to be assigned to the global chunk hosting the heap.

(generated from Symbian Developer Library)

◆ SetGrowBy()

void TChunkHeapCreateInfo::SetGrowBy ( TInt aGrowBy )

inline

Sets the increments to the size of the host chunk.

If the supplied value is less than KMinHeapGrowBy, it is discarded and the value KMinHeapGrowBy is used instead.

This overrides any previous call to TChunkHeapCreateInfo::SetGrowBy() for this TChunkHeapCreateInfo object.

Parameters

aGrowBy The increment to the size of the host chunk.

(generated from Symbian Developer Library)

◆ SetMode()

void TChunkHeapCreateInfo::SetMode ( TUint aMode )

inline

Sets the mode flags of the chunk heap.

This overrides any previous call to TChunkHeapCreateInfo::SetMode() for this TChunkHeapCreateInfo object.

Parameters

aMode The mode flags for the chunk heap to be created, this should be one or more of the values from TChunkHeapCreateMode.

(generated from Symbian Developer Library)

◆ SetOffset()

void TChunkHeapCreateInfo::SetOffset ( TInt aOffset )

inline

Sets the offset from the base of the host chunk to the start of the heap.

This overrides any previous call to TChunkHeapCreateInfo::SetOffset() for this TChunkHeapCreateInfo object.

Parameters

aOffset The offset in bytes.

(generated from Symbian Developer Library)

◆ SetPaging()

void TChunkHeapCreateInfo::SetPaging ( const TChunkHeapPagingAtt aPaging )

inline

Sets the paging attribute of the chunk heap to be created.

This overrides any previous call to TChunkHeapCreateInfo::SetPaging() for this TChunkHeapCreateInfo object.

Parameters

aPaging The paging attribute for the chunk heap to be created.

(generated from Symbian Developer Library)

◆ SetSingleThread()

void TChunkHeapCreateInfo::SetSingleThread ( TBool aSingleThread )

inline

Sets single thread property of the chunk heap.

This overrides any previous call to TChunkHeapCreateInfo::SetSingleThread() for this TChunkHeapCreateInfo object.

Parameters

aSingleThread ETrue when the chunk heap is to be single threaded, EFalse otherwise.

(generated from Symbian Developer Library)

◆ SetUseChunk()

IMPORT_C void TChunkHeapCreateInfo::SetUseChunk ( const RChunk aChunk )

Sets the chunk heap to be created to use the chunk specified.

This overriddes any previous call to TChunkHeapCreateInfo::SetNewChunkHeap() or TChunkHeapCreateInfo::SetExistingChunkHeap() for this TChunkHeapCreateInfo object.

Parameters

aChunk A handle to the chunk to use for the heap.

(generated from Symbian Developer Library)

Friends And Related Symbol Documentation

◆ UserHeap

friend class UserHeap

friend

Definition at line 3780 of file e32std.h.

Member Data Documentation

◆ iAlign

TInt TChunkHeapCreateInfo::iAlign

protected

The alignment of the heap.

API status: Internal component API.

Definition at line 3816 of file e32std.h.

◆ iChunk

RChunk TChunkHeapCreateInfo::iChunk

protected

The chunk to use for the heap.

API status: Internal component API.

Definition at line 3858 of file e32std.h.

◆ iGrowBy

TInt TChunkHeapCreateInfo::iGrowBy

protected

The grow by value of the heap.

API status: Internal component API.

Definition at line 3822 of file e32std.h.

◆ iMaxLength

TInt TChunkHeapCreateInfo::iMaxLength

protected

The maximum size for the heap.

API status: Internal component API.

Definition at line 3810 of file e32std.h.

◆ iMinLength

TInt TChunkHeapCreateInfo::iMinLength

protected

The minimum size for the heap.

API status: Internal component API.

Definition at line 3804 of file e32std.h.

◆ iMode

TUint TChunkHeapCreateInfo::iMode

protected

The mode flags for the heap.

API status: Internal component API.

Definition at line 3846 of file e32std.h.

◆ iName

TDesC* TChunkHeapCreateInfo::iName

protected

The name of the chunk to be created for the heap.

API status: Internal component API.

Definition at line 3852 of file e32std.h.

◆ iOffset

TInt TChunkHeapCreateInfo::iOffset

protected

The offset from the base of the chunk to the start of the heap.

API status: Internal component API.

Definition at line 3834 of file e32std.h.

◆ iPaging

TChunkHeapPagingAtt TChunkHeapCreateInfo::iPaging

protected

The paging attributes of the chunk.

API status: Internal component API.

Definition at line 3840 of file e32std.h.

◆ iSingleThread

TBool TChunkHeapCreateInfo::iSingleThread

protected

The single thread value of the heap.

API status: Internal component API.

Definition at line 3828 of file e32std.h.

◆ iSpare

TInt TChunkHeapCreateInfo::iSpare[5]

protected

API status: Internal component API.

Definition at line 3864 of file e32std.h.

◆ iVersionNumber

TUint TChunkHeapCreateInfo::iVersionNumber

protected

The version number of this TChunkHeapCreateInfo.

API status: Internal component API.

Definition at line 3798 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

◆ TChunkHeapCreateVersions

◆ TChunkHeapPagingAtt

Constructor & Destructor Documentation

◆ TChunkHeapCreateInfo()

Member Function Documentation

◆ SetAlignment()

◆ SetCreateChunk()

◆ SetGrowBy()

◆ SetMode()

◆ SetOffset()

◆ SetPaging()

◆ SetSingleThread()

◆ SetUseChunk()

Friends And Related Symbol Documentation

◆ UserHeap

Member Data Documentation

◆ iAlign

◆ iChunk

◆ iGrowBy

◆ iMaxLength

◆ iMinLength

◆ iMode

◆ iName

◆ iOffset

◆ iPaging

◆ iSingleThread

◆ iSpare

◆ iVersionNumber