#include <e32std.h>
struct TChunkHeapCreateInfo |
Protected Attributes | |
---|---|
TInt | iAlign |
RChunk | iChunk |
TInt | iGrowBy |
TInt | iMaxLength |
TInt | iMinLength |
TUint | iMode |
TDesC * | iName |
TInt | iOffset |
TChunkHeapPagingAtt | iPaging |
TBool | iSingleThread |
TInt | iSpare |
TUint | iVersionNumber |
Public Member Enumerations | |
---|---|
enum | TChunkHeapCreateVersions { EVersion0, ESupportedVersions } |
enum | TChunkHeapPagingAtt { EUnspecified, EPaged, EUnpaged } |
Public Member Functions | |
---|---|
TChunkHeapCreateInfo(TInt, TInt) | |
void | SetAlignment(TInt) |
IMPORT_C void | SetCreateChunk(const TDesC *) |
void | SetGrowBy(TInt) |
void | SetMode(TUint) |
void | SetOffset(TInt) |
void | SetPaging(const TChunkHeapPagingAtt) |
void | SetSingleThread(TBool) |
IMPORT_C void | SetUseChunk(const RChunk) |
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.
TInt | iSpare | [protected] |
Currently supported version numbers
Enumerator | Value | Description |
---|---|---|
EVersion0 | ||
ESupportedVersions |
Attributes that specify whether the chunk heap to be created is data paged or not.
Enumerator | Value | Description |
---|---|---|
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. |
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 a page size, then it is discarded and the page size is used instead. |
void | 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.
IMPORT_C void | 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. |
void | 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. |
void | 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. |
void | 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. |
void | 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. |
void | 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. |
IMPORT_C void | 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. |