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

#include <e32std.h>

Public Types
enum	TThreadCreateVersions { EVersion0 , ESupportedVersions }

enum	TThreadPagingAtt { EUnspecified , EPaged , EUnpaged }
	Attributes that specify whether the stack and heap of the thread to be created are data paged or not. More...

Public Member Functions
IMPORT_C	TThreadCreateInfo (const TDesC &aName, TThreadFunction aFunction, TInt aStackSize, TAny *aPtr)
	Constructor where the basic properties of the thread to be created are specified.

IMPORT_C void	SetCreateHeap (TInt aHeapMinSize, TInt aHeapMaxSize)
	Sets the thread to be created to create its own heap.

IMPORT_C void	SetUseHeap (const RAllocator *aHeap)
	Sets the thread to be created to use the heap whose handle is pointed to by aAllocator.

IMPORT_C void	SetOwner (const TOwnerType aOwner)
	Sets the owner the thread to be created.

IMPORT_C void	SetPaging (const TThreadPagingAtt aPaging)
	Sets the data paging attributes of the thread to be created.

Protected Attributes
TUint	iVersionNumber
	The version number of this TChunkCreateInfo.

const TDesC *	iName
	The Name to be given to the thread to be created.

TThreadFunction	iFunction
	The function this thread will execute.

TInt	iStackSize
	The size of the stack of the thread to be created.

TAny *	iParameter
	The parameter to be passed to the function of the thread to be created.

TOwnerType	iOwner
	The owner of the thread to be created.

RAllocator *	iHeap
	The heap for the thread to be created to use.

TInt	iHeapMinSize
	Minimum size of any heap to be created for the thread.

TInt	iHeapMaxSize
	Maximum size of any heap to be created for the thread.

TUint	iAttributes
	The attributes of the thread.

TUint32	iSpare [6]

Friends
class	RThread

Detailed Description

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

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

API status: Published to all clients. Released API.

Definition at line 3972 of file e32std.h.

Member Enumeration Documentation

◆ TThreadCreateVersions

enum TThreadCreateInfo::TThreadCreateVersions

Currently supported version numbers

API status: Internal component API.

Enumerator
EVersion0
ESupportedVersions

Definition at line 3981 of file e32std.h.

◆ TThreadPagingAtt

enum TThreadCreateInfo::TThreadPagingAtt

Attributes that specify whether the stack and heap of the thread to be created are data paged or not.

Enumerator
EUnspecified	The thread will use the creating process's paging attributes.
EPaged	The thread will data page its stack and heap.
EUnpaged	The thread will not data page its stack and heap.

Definition at line 3991 of file e32std.h.

Constructor & Destructor Documentation

◆ TThreadCreateInfo()

IMPORT_C TThreadCreateInfo::TThreadCreateInfo	(	const TDesC &	aName,
		TThreadFunction	aFunction,
		TInt	aStackSize,
		TAny *	aPtr
	)

Constructor where the basic properties of the thread to be created are specified.

NOTE - TThreadCreateInfo::SetCreateHeap() or TThreadCreateInfo::SetUseHeap() must be invoked on this TThreadCreateInfo to set the type of the thread to be created before being passed as a paramter to RThread::Create().

Parameters

aName	The name to be assigned to the thread. KNullDesC, to create an anonymous thread.
aFunction	A pointer to a function. Control passes to this function when the thread is first resumed, i.e. when the thread is initially scheduled to run.
aStackSize	The size of the new thread's stack. This must be at least 512 bytes, otherwise RThread::Create() will fail with KErrArgument.
aPtr	A pointer to data to be passed as a parameter to the thread function when the thread is initially scheduled to run. If the thread function does not need any data then this pointer can be NULL.

(generated from Symbian Developer Library)

Member Function Documentation

◆ SetCreateHeap()

IMPORT_C void TThreadCreateInfo::SetCreateHeap	(	TInt	aHeapMinSize,
		TInt	aHeapMaxSize
	)

Sets the thread to be created to create its own heap.

Parameters

aHeapMinSize	The minimum size for the new thread's heap.
aHeapMaxSize	The maximum size for the new thread's heap.

(generated from Symbian Developer Library)

◆ SetOwner()

IMPORT_C void TThreadCreateInfo::SetOwner ( const TOwnerType aOwner )

Sets the owner the thread to be created.

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

Parameters

aOwner The owner of the thread to be created.

(generated from Symbian Developer Library)

◆ SetPaging()

IMPORT_C void TThreadCreateInfo::SetPaging ( const TThreadPagingAtt aPaging )

Sets the data paging attributes of the thread to be created.

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

Parameters

aPaging The paging attributes for the thread to be created.

(generated from Symbian Developer Library)

◆ SetUseHeap()

IMPORT_C void TThreadCreateInfo::SetUseHeap ( const RAllocator * aHeap )

Sets the thread to be created to use the heap whose handle is pointed to by aAllocator.

If this is NULL, then the thread uses the heap of the creating thread.

Parameters

aHeap A pointer to the handle of the heap belonging to another thread which this thread is to use.

(generated from Symbian Developer Library)

Friends And Related Symbol Documentation

◆ RThread

friend class RThread

friend

Definition at line 3998 of file e32std.h.

Member Data Documentation

◆ iAttributes

TUint TThreadCreateInfo::iAttributes

protected

The attributes of the thread.

API status: Internal component API.

Definition at line 4068 of file e32std.h.

◆ iFunction

TThreadFunction TThreadCreateInfo::iFunction

protected

The function this thread will execute.

API status: Internal component API.

Definition at line 4025 of file e32std.h.

◆ iHeap

RAllocator* TThreadCreateInfo::iHeap

protected

The heap for the thread to be created to use.

NULL if a new heap is to be created.

API status: Internal component API.

Definition at line 4050 of file e32std.h.

◆ iHeapMaxSize

TInt TThreadCreateInfo::iHeapMaxSize

protected

Maximum size of any heap to be created for the thread.

API status: Internal component API.

Definition at line 4062 of file e32std.h.

◆ iHeapMinSize

TInt TThreadCreateInfo::iHeapMinSize

protected

Minimum size of any heap to be created for the thread.

API status: Internal component API.

Definition at line 4056 of file e32std.h.

◆ iName

const TDesC* TThreadCreateInfo::iName

protected

The Name to be given to the thread to be created.

API status: Internal component API.

Definition at line 4019 of file e32std.h.

◆ iOwner

TOwnerType TThreadCreateInfo::iOwner

protected

The owner of the thread to be created.

API status: Internal component API.

Definition at line 4043 of file e32std.h.

◆ iParameter

TAny* TThreadCreateInfo::iParameter

protected

The parameter to be passed to the function of the thread to be created.

API status: Internal component API.

Definition at line 4037 of file e32std.h.

◆ iSpare

TUint32 TThreadCreateInfo::iSpare[6]

protected

API status: Internal component API.

Definition at line 4074 of file e32std.h.

◆ iStackSize

TInt TThreadCreateInfo::iStackSize

protected

The size of the stack of the thread to be created.

API status: Internal component API.

Definition at line 4031 of file e32std.h.

◆ iVersionNumber

TUint TThreadCreateInfo::iVersionNumber

protected

The version number of this TChunkCreateInfo.

API status: Internal component API.

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

◆ TThreadCreateVersions

◆ TThreadPagingAtt

Constructor & Destructor Documentation

◆ TThreadCreateInfo()

Member Function Documentation

◆ SetCreateHeap()

◆ SetOwner()

◆ SetPaging()

◆ SetUseHeap()

Friends And Related Symbol Documentation

◆ RThread

Member Data Documentation

◆ iAttributes

◆ iFunction

◆ iHeap

◆ iHeapMaxSize

◆ iHeapMinSize

◆ iName

◆ iOwner

◆ iParameter

◆ iSpare

◆ iStackSize

◆ iVersionNumber