| struct TChunkHeapCreateInfo |
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.
| 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) |
| Public Member Enumerations | |
|---|---|
| enum | TChunkHeapCreateVersions { EVersion0, ESupportedVersions } |
| enum | TChunkHeapPagingAtt { EUnspecified, EPaged, EUnpaged } |
| 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 |
| 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.
| TInt aAlign |
| IMPORT_C void | SetCreateChunk | ( | const TDesC * | aName | ) |
| const TDesC * aName |
| 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.
| TInt 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.
| TUint 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.
| TInt 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.
| const TChunkHeapPagingAtt 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.
| TBool aSingleThread | ETrue when the chunk heap is to be single threaded, EFalse otherwise. |
| IMPORT_C void | SetUseChunk | ( | const RChunk | aChunk | ) |
| const RChunk aChunk |
Currently supported version numbers
| EVersion0 | |
| ESupportedVersions |
Attributes that specify whether the chunk heap to be created is data paged or not.
| 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. |
| TInt | iOffset | [protected] |
The offset from the base of the chunk to the start of the heap.
| TChunkHeapPagingAtt | iPaging | [protected] |
The paging attributes of the chunk.
| TUint | iVersionNumber | [protected] |
The version number of this TChunkHeapCreateInfo.