#include <e32std.h>
| struct TChunkCreateInfo |
| Protected Attributes | |
|---|---|
| TUint | iAttributes |
| TUint8 | iClearByte |
| TBool | iGlobal |
| TInt | iInitialBottom |
| TInt | iInitialTop |
| TInt | iMaxSize |
| const TDesC * | iName |
| TOwnerType | iOwnerType |
| TUint8 | iSpare1 |
| TUint | iSpare2 |
| TUint | iType |
| TUint | iVersionNumber |
| Public Member Enumerations | |
|---|---|
| enum | TChunkCreateVersions { EVersion0, ESupportedVersions } |
| enum | TChunkPagingAtt { EUnspecified, EPaged, EUnpaged } |
| Public Member Functions | |
|---|---|
| TChunkCreateInfo() | |
| IMPORT_C void | SetCache(TInt) |
| IMPORT_C void | SetClearByte(TUint8) |
| IMPORT_C void | SetCode(TInt, TInt) |
| IMPORT_C void | SetDisconnected(TInt, TInt, TInt) |
| IMPORT_C void | SetDoubleEnded(TInt, TInt, TInt) |
| IMPORT_C void | SetGlobal(const TDesC &) |
| IMPORT_C void | SetNormal(TInt, TInt) |
| IMPORT_C void | SetOwner(TOwnerType) |
| IMPORT_C void | SetPaging(const TChunkPagingAtt) |
| IMPORT_C void | SetReadOnly() |
| void | SetThreadHeap(TInt, TInt, const TDesC &) |
This structure specifies the type and properties of the chunk to be created. It is passed as a parameter to the RChunk::Create() method.
| TUint | iAttributes | [protected] |
Attributes to the chunk to be created should have. Should be set from one or more the values in TChunkCreate::TChunkCreateAtt.
| TInt | 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.
| TInt | 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.
| const TDesC * | 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.
| TOwnerType | iOwnerType | [protected] |
An enumeration whose enumerators define the ownership of this chunk handle. If not explicitly specified, EOwnerProcess is taken as default.
| IMPORT_C | 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.
| IMPORT_C void | SetClearByte | ( | TUint8 | aClearByte | ) |
Sets the byte value that all memory committed to the chunk will be cleared to.
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.
See also: RChunk::CreateLocalCode()
| Parameter | Description |
|---|---|
| aInitialSize | The number of bytes committed to this chunk. |
| aMaxSize | The maximum size to which the reserved region of this chunk can grow. |
Set the chunk to be created to have a committed region consisting of an arbitrary set of MMU pages within the reserved region.
See also: RChunk::CreateDisconnectedLocal()
| Parameter | Description |
|---|---|
| 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. |
Sets the chunk to be created to have a commited region that that can be any contiguous subset of the reserved region.
See also: RChunk::CreateDoubleEndedLocal()
| Parameter | Description |
|---|---|
| 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. |
| IMPORT_C void | 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.
| Parameter | Description |
|---|---|
| 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. |
Sets the chunk to be created to have a committed region that always starts at the bottom of the reserved region.
See also: RChunk::CreateLocal()
| Parameter | Description |
|---|---|
| aMaxSize | The maximum size to which the reserved region of this chunk can grow. |
| IMPORT_C void | SetOwner | ( | TOwnerType | aType | ) |
Sets the owner of the chunk to be created.
| Parameter | Description |
|---|---|
| aType | The owner of the chunk to be created. |
| IMPORT_C void | 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.
| Parameter | Description |
|---|---|
| aPaging | The data paging attributes of the chunk to be created. |
| IMPORT_C void | 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.
Sets the chunk to be created to be a thread heap chunk. For internal use only.
| Parameter | Description |
|---|---|
| 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 |