User Class Reference

class User : public UserHeap

Set of static user functions.

These functions are related to a number of System component APIs.

The majority of the functions are related to either the current thread, or its heap. Examples in this category include User::Exit() , which causes the thread to terminate, and User::Alloc() , which allocates memory from the current thread's heap.

Some of these functions are equivalent to functions in the RThread or RHeap classes. In these cases, the User function is a convenient way to access the function without first having to get a handle to the current thread.

Functions are also provided to support debugging of memory leaks. These function calls can be written explicitly or can be generated using a corresponding macro - the advantage of using a macro is that the function call is only generated for debug builds.

A final category of functions, which includes User::BinarySearch() and User::QuickSort() , are just useful functions which have no other natural home.

RThread RHeap

Inherits from

Public Member Functions
IMPORT_C void After ( TTimeIntervalMicroSeconds32 )
IMPORT_C void AfterHighRes ( TTimeIntervalMicroSeconds32 )
IMPORT_C TAny * Alloc ( TInt )
IMPORT_C TAny * AllocL ( TInt )
IMPORT_C TAny * AllocLC ( TInt )
IMPORT_C TInt AllocLen (const TAny *)
IMPORT_C TInt AllocSize ( TInt &)
IMPORT_C TAny * AllocZ ( TInt )
IMPORT_C TAny * AllocZL ( TInt )
IMPORT_C RAllocator & Allocator ()
IMPORT_C TInt At (const TTime &)
IMPORT_C TInt Available ( TInt &)
IMPORT_C TInt Beep ( TInt , TTimeIntervalMicroSeconds32 )
IMPORT_C TInt BinarySearch ( TInt , const TKey &, TInt &)
IMPORT_C void CancelMiscNotifier ( TRequestStatus &)
IMPORT_C void Check ()
IMPORT_C TUint Collate ( TUint )
IMPORT_C void CommandLine ( TDes &)
IMPORT_C TInt CommandLineLength ()
IMPORT_C TInt CompressAllHeaps ()
IMPORT_C TInt CountAllocCells ()
IMPORT_C TInt CountAllocCells ( TInt &)
TBool CreatorHasCapability ( TCapability , const char *)
TBool CreatorHasCapability ( TCapability , TCapability , const char *)
TUid CreatorIdentity ()
IMPORT_C TSecureId CreatorSecureId ()
IMPORT_C TVendorId CreatorVendorId ()
IMPORT_C TCritical Critical ()
IMPORT_C TCritical Critical ( RThread )
IMPORT_C TExceptionHandler ExceptionHandler ()
IMPORT_C void Exit ( TInt )
IMPORT_C TUint32 FastCounter ()
IMPORT_C TUint Fold ( TUint )
IMPORT_C TUint Fold ( TUint , TInt )
IMPORT_C void Free ( TAny *)
IMPORT_C TInt FreeLogicalDevice (const TDesC &)
IMPORT_C TInt FreePhysicalDevice (const TDesC &)
IMPORT_C void FreeZ ( TAny *&)
IMPORT_C TInt GetDesParameter ( TInt , TDes8 &)
IMPORT_C TInt GetDesParameter ( TInt , TDes16 &)
IMPORT_C TInt GetTIntParameter ( TInt , TInt &)
IMPORT_C void HandleException ( TAny *)
RHeap & Heap ()
IMPORT_C void IMB_Range ( TAny *, TAny *)
TUid Identity ()
IMPORT_C TTimeIntervalSeconds InactivityTime ()
IMPORT_C TInt InfoPrint (const TDesC &)
IMPORT_C void InitProcess ()
IMPORT_C void Invariant ()
IMPORT_C TBool IsExceptionHandled ( TExcType )
IMPORT_C TInt IsRomAddress ( TBool &, TAny *)
IMPORT_C TBool JustInTime ()
IMPORT_C TLanguage Language ()
IMPORT_C void Leave ( TInt )
IMPORT_C void LeaveEnd ()
IMPORT_C TInt LeaveIfError ( TInt )
IMPORT_C TAny * LeaveIfNull ( TAny *)
const TAny * LeaveIfNull (const TAny *)
IMPORT_C void LeaveNoMemory ()
IMPORT_C TInt LoadLogicalDevice (const TDesC &)
IMPORT_C TInt LoadPhysicalDevice (const TDesC &)
IMPORT_C TTimerLockSpec LockPeriod ()
IMPORT_C TInt LockedDec ( TInt &)
IMPORT_C TInt LockedInc ( TInt &)
IMPORT_C TUint LowerCase ( TUint )
IMPORT_C TInt MachineConfiguration ( TDes8 &, TInt &)
IMPORT_C TTrapHandler * MarkCleanupStack ()
IMPORT_C void ModifyExceptionMask ( TUint32 , TUint32 )
IMPORT_C TUint32 NTickCount ()
IMPORT_C void NotifyOnIdle ( TRequestStatus &)
IMPORT_C void Panic (const TDesC &, TInt )
IMPORT_C void PanicUnexpectedLeave ()
IMPORT_C TInt ParameterLength ( TInt )
IMPORT_C TBool PriorityControl ()
IMPORT_C TCritical ProcessCritical ()
IMPORT_C TCritical ProcessCritical ( RProcess )
IMPORT_C TBool QueryVersionSupported (const TVersion &, const TVersion &)
IMPORT_C TInt QuickSort ( TInt , const TKey &, const TSwap &)
IMPORT_C TInt RaiseException ( TExcType )
IMPORT_C TAny * ReAlloc ( TAny *, TInt , TInt )
IMPORT_C TAny * ReAllocL ( TAny *, TInt , TInt )
IMPORT_C TRegionCode RegionCode ()
IMPORT_C TInt RenameProcess (const TDesC &)
IMPORT_C TInt RenameThread (const TDesC &)
IMPORT_C void RequestComplete ( TRequestStatus *&, TInt )
IMPORT_C void ResetInactivityTime ()
IMPORT_C TInt SafeDec ( TInt &)
IMPORT_C TInt SafeInc ( TInt &)
IMPORT_C TInt SetCritical ( TCritical )
IMPORT_C TInt SetCurrencySymbol (const TDesC &)
IMPORT_C void SetDebugMask ( TUint32 )
IMPORT_C void SetDebugMask ( TUint32 , TUint )
IMPORT_C TInt SetExceptionHandler ( TExceptionHandler , TUint32 )
IMPORT_C TInt SetFloatingPointMode ( TFloatingPointMode , TFloatingPointRoundingMode )
IMPORT_C TInt SetHomeTime (const TTime &)
IMPORT_C TInt SetHomeTimeSecure (const TTime &)
IMPORT_C void SetJustInTime (const TBool )
IMPORT_C TInt SetMachineConfiguration (const TDesC8 &)
IMPORT_C void SetPriorityControl ( TBool )
IMPORT_C TInt SetProcessCritical ( TCritical )
IMPORT_C TInt SetRealtimeState ( TRealtimeState )
IMPORT_C TTrapHandler * SetTrapHandler ( TTrapHandler *)
IMPORT_C void SetUTCOffset ( TTimeIntervalSeconds )
IMPORT_C TInt SetUTCTime (const TTime &)
IMPORT_C TInt SetUTCTimeAndOffset (const TTime &, TTimeIntervalSeconds )
IMPORT_C TInt SetUTCTimeSecure (const TTime &)
IMPORT_C TInt StringLength (const TUint8 *)
IMPORT_C TInt StringLength (const TUint16 *)
IMPORT_C RAllocator * SwitchAllocator ( RAllocator *)
RHeap * SwitchHeap ( RAllocator *)
IMPORT_C TUint TickCount ()
IMPORT_C TUint TitleCase ( TUint )
IMPORT_C TTrapHandler * TrapHandler ()
IMPORT_C TTimeIntervalSeconds UTCOffset ()
IMPORT_C void UnMarkCleanupStack ( TTrapHandler *)
IMPORT_C TUint UpperCase ( TUint )
IMPORT_C TInt ValidateName (const TDesC &)
IMPORT_C TVersion Version ()
IMPORT_C void WaitForAnyRequest ()
IMPORT_C void WaitForNRequest ( TRequestStatus *, TInt )
IMPORT_C void WaitForRequest ( TRequestStatus &)
IMPORT_C void WaitForRequest ( TRequestStatus &, TRequestStatus &)
IMPORT_C TUint __DbgCheckFailure ( TBool )
IMPORT_C void __DbgMarkCheck ( TBool , TBool , TInt , const TUint8 *, TInt )
IMPORT_C TUint32 __DbgMarkEnd ( TBool , TInt )
IMPORT_C void __DbgMarkStart ( TBool )
IMPORT_C void __DbgSetAllocFail ( TBool , RAllocator::TAllocFail , TInt )
IMPORT_C void __DbgSetBurstAllocFail ( TBool , RAllocator::TAllocFail , TUint , TUint )
Private Member Functions
IMPORT_C TBool DoCreatorHasCapability ( TCapability , const char *)
IMPORT_C TBool DoCreatorHasCapability ( TCapability )
IMPORT_C TBool DoCreatorHasCapability ( TCapability , TCapability , const char *)
IMPORT_C TBool DoCreatorHasCapability ( TCapability , TCapability )
Inherited Functions
UserHeap::ChunkHeap(RChunk,TInt,TInt,TInt,TInt,TBool,TUint32)
UserHeap::ChunkHeap(const TChunkHeapCreateInfo &)
UserHeap::ChunkHeap(const TDesC *,TInt,TInt,TInt,TInt,TBool)
UserHeap::CreateThreadHeap(SStdEpocThreadCreateInfo &,RHeap *&,TInt,TBool)
UserHeap::FixedHeap(TAny *,TInt,TInt,TBool)
UserHeap::OffsetChunkHeap(RChunk,TInt,TInt,TInt,TInt,TInt,TBool,TUint32)
UserHeap::SetupThreadHeap(TBool,SStdEpocThreadCreateInfo &)
Public Member Enumerations
enum TCritical {
ENotCritical , EProcessCritical , EProcessPermanent , EAllThreadsCritical , ESystemCritical , ESystemPermanent
}
enum TRealtimeState { ERealtimeStateOff , ERealtimeStateOn , ERealtimeStateWarn }
Inherited Enumerations
UserHeap:TChunkHeapCreateMode

Member Functions Documentation

After(TTimeIntervalMicroSeconds32)

IMPORT_C void After ( TTimeIntervalMicroSeconds32 aInterval ) [static]

Suspends the current thread until a specified time interval has expired.

The resolution of the timer depends on the hardware, but is normally 1 Symbian OS tick (approximately 1/64 second).

panic
USER 86, if the time interval is negative.

Parameters

TTimeIntervalMicroSeconds32 aInterval The time interval for which the current thread is to be suspended, in microseconds.

AfterHighRes(TTimeIntervalMicroSeconds32)

IMPORT_C void AfterHighRes ( TTimeIntervalMicroSeconds32 aInterval ) [static]

Suspends the current thread until a specified time interval has expired to a resolution of 1ms .

panic
USER 86, if the time interval is negative.

Parameters

TTimeIntervalMicroSeconds32 aInterval The time interval for which the current thread is to be suspended, in microseconds.

Alloc(TInt)

IMPORT_C TAny * Alloc ( TInt aSize ) [static]

Allocates a cell of specified size from the current thread's heap.

If there is insufficient memory available on the heap from which to allocate a cell of the required size, the function returns NULL.

The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.

panic
USER 47, if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling Alloc(-1) raises this panic.

Parameters

TInt aSize The size of the cell to be allocated from the current thread's heap.

AllocL(TInt)

IMPORT_C TAny * AllocL ( TInt aSize ) [static]

Allocates a cell of specified size from the current thread's heap, and leaves if there is insufficient memory in the heap.

The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.

panic
USER 47, if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling Alloc(-1) raises this panic.

Parameters

TInt aSize The size of the cell to be allocated from the current thread's heap.

AllocLC(TInt)

IMPORT_C TAny * AllocLC ( TInt aSize ) [static]

Allocates a cell of specified size from the current thread's default heap, and, if successful, places a pointer to the cell onto the cleanup stack.

The function leaves if there is insufficient memory in the heap.

The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.

panic
USER 47, if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling Alloc(-1) raises this panic.

Parameters

TInt aSize The size of the cell to be allocated from the current thread's default heap.

AllocLen(const TAny *)

IMPORT_C TInt AllocLen ( const TAny * aCell ) [static]

Gets the length of the specified allocated heap cell.

The cell is assumed to be in the current thread's heap.

Parameters

const TAny * aCell A pointer to the allocated cell whose length is to be fetched.

AllocSize(TInt &)

IMPORT_C TInt AllocSize ( TInt & aTotalAllocSize ) [static]

Gets the total number of cells allocated on the current thread's default heap, and the total space allocated to them.

Parameters

TInt & aTotalAllocSize On return, contains the total space allocated to the cells.

AllocZ(TInt)

IMPORT_C TAny * AllocZ ( TInt aSize ) [static]

Allocates a cell of specified size from the current thread's default heap, and clears it to binary zeroes.

If there is insufficient memory available on the heap from which to allocate a cell of the required size, the function returns NULL.

The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.

panic
USER 47, if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling Alloc(-1) raises this panic.

Parameters

TInt aSize The size of the cell to be allocated from the current thread's default heap.

AllocZL(TInt)

IMPORT_C TAny * AllocZL ( TInt aSize ) [static]

Allocates a cell of specified size from the current thread's default heap, clears it to binary zeroes, and leaves if there is insufficient memory in the heap.

The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.

panic
USER 47, if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling Alloc(-1) raises this panic.

Parameters

TInt aSize The size of the cell to be allocated from the current thread's heap.

Allocator()

IMPORT_C RAllocator & Allocator ( ) [static]

Gets the current thread's default current heap.

At(const TTime &)

IMPORT_C TInt At ( const TTime & aTime ) [static]

Suspends the current thread until the specified absolute time, in the current time zone.

If the machine is off at that time, the machine will be turned on again.

KErrNone - suspension of the current thread completed normally at the requested time.

KErrAbort - suspension of the current thread was aborted because the system time changed.

KErrUnderflow - the requested completion time is in the past.

KErrOverFlow - the requested completion time is too far in the future.

Parameters

const TTime & aTime The absolute time, in the current time zone, until which the current thread is to be suspended.

Available(TInt &)

IMPORT_C TInt Available ( TInt & aBiggestBlock ) [static]

Gets the total free space currently available on the current thread's default heap, and the space available in the largest free block.

The space available represents the total space which can be allocated.

Note that compressing the heap may reduce the total free space available and the space available in the largest free block.

Parameters

TInt & aBiggestBlock On return, contains the space available in the largest free block on the current thread's default heap.

Beep(TInt, TTimeIntervalMicroSeconds32)

IMPORT_C TInt Beep ( TInt aFrequency,
TTimeIntervalMicroSeconds32 aDuration
) [static]

Makes a beep tone with a specified frequency and duration.

This function should not be used. It exists to maintain compatibility with older versions of Symban OS.

Parameters

TInt aFrequency
TTimeIntervalMicroSeconds32 aDuration

BinarySearch(TInt, const TKey &, TInt &)

IMPORT_C TInt BinarySearch ( TInt aCount,
const TKey & aKey,
TInt & aPos
) [static]

Performs a binary search for an array element containing a specified key.

It can be used on any kind of array where elements can be identified by key. It is used by the standard Symbian OS arrays having CArrayFix , CArrayVar or CArrayPak in their class hierarchy in the implementation of the various functions for inserting, deleting and finding elements by key. The function can be used by other arrays.

The function returns a zero value if the search is successful and a non-zero value otherwise.

If the search is successful, the function puts the position (i.e. the index) of the element into aPos. If the search is unsuccessful, then the function puts into aPos the position of the first element in the array whose key is greater than the search key.

If the array is empty, i.e. aCount is zero, then the search is unsuccessful and aPos is not defined.

panic
USER 97, if aCount is negative.

Parameters

TInt aCount The number of elements in the array.
const TKey & aKey A reference to a suitably initialised TKey derived object. In particular, the object will have been initialised with a pointer to a sample element containing the search key.
TInt & aPos If the element is found, the reference is set to the position of that element within the array. The position is relative to zero, (i.e. the first element in the array is at position 0). If the element is not found and the array is not empty, then the reference is set to the position of the first element in the array with a key which is greater than the search key. If the element is not found and the array is empty, then the reference is undefined.

CancelMiscNotifier(TRequestStatus &)

IMPORT_C void CancelMiscNotifier ( TRequestStatus & aStatus ) [static]

Cancel a miscellaneous notification requested by this thread

Cancels a currently outstanding notification for system idle or object deletion.

Parameters

TRequestStatus & aStatus

Check()

IMPORT_C void Check ( ) [static]

Checks the validity of the current thread's default heap.

The function walks through the list of allocated cells and the list of free cells checking that the heap is consistent and complete.

panic
USER 47 if any corruption is found, specifically a bad allocated heap cell size.
panic
USER 48 if any corruption is found, specifically a bad allocated heap cell address.
panic
USER 49 if any corruption is found, specifically a bad free heap cell address.

Collate(TUint)

IMPORT_C TUint Collate ( TUint aChar ) [static]

Converts the character to its collated form.

Collating is the process of removing differences between characters that are deemed unimportant for the purposes of ordering characters. The result of the conversion depends on the locale and on whether this is a UNICODE build or not.

Note that for a non UNICODE build, if the binary value of the character aChar is greater than or equal to 0x100, then the character returned is the same as the character passed to the function.

Parameters

TUint aChar The character to be folded.

CommandLine(TDes &)

IMPORT_C void CommandLine ( TDes & aCommand ) [static]

Gets a copy of the data which is passed as an argument to the thread function of the current process's main thread when it is first scheduled to run.

User::CommandLineLength()

Parameters

TDes & aCommand A modifiable descriptor supplied by the caller into which the argument data is put. The descriptor must be big enough to contain the expected data, otherwise the function raises a panic.

CommandLineLength()

IMPORT_C TInt CommandLineLength ( ) [static]

Gets the length of the data which is passed as an argument to the thread function of the current process's main thread when it is first scheduled to run.

CompressAllHeaps()

IMPORT_C TInt CompressAllHeaps ( ) [static]

Compresses all the chunks containing heaps.

This function is no longer supported, and calling it has no effect.

CountAllocCells()

IMPORT_C TInt CountAllocCells ( ) [static]

Gets the total number of cells allocated on the current thread's default heap.

CountAllocCells(TInt &)

IMPORT_C TInt CountAllocCells ( TInt & aFreeCount ) [static]

Gets the the total number of cells allocated, and the number of free cells, on the current thread's default heap.

Parameters

TInt & aFreeCount On return, contains the number of free cells on the current thread's default heap.

CreatorHasCapability(TCapability, const char *)

TBool CreatorHasCapability ( TCapability aCapability,
const char * aDiagnostic = 0
) [static, inline]

Check if the process that created the current process has a given capability

When a check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return ETrue even though the check failed.

Parameters

TCapability aCapability The capability to test.
const char * aDiagnostic = 0 A string that will be emitted along with any diagnostic message that may be issued if the test finds the capability is not present. This string must be enclosed in the __PLATSEC_DIAGNOSTIC_STRING macro which enables it to be easily removed from the system.

CreatorHasCapability(TCapability, TCapability, const char *)

TBool CreatorHasCapability ( TCapability aCapability1,
TCapability aCapability2,
const char * aDiagnostic = 0
) [static, inline]

Check if the process that created the current process has both of the given capabilities

When a check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return ETrue even though the check failed.

Parameters

TCapability aCapability1 The first capability to test.
TCapability aCapability2 The second capability to test.
const char * aDiagnostic = 0 A string that will be emitted along with any diagnostic message that may be issued if the test finds a capability is not present. This string must be enclosed in the __PLATSEC_DIAGNOSTIC_STRING macro which enables it to be easily removed from the system.

CreatorIdentity()

TUid CreatorIdentity ( ) [static, inline]

CreatorSecureId()

IMPORT_C TSecureId CreatorSecureId ( ) [static]

Return the Secure ID of the process that created the current process.

CreatorVendorId()

IMPORT_C TVendorId CreatorVendorId ( ) [static]

Return the Vendor ID of the process that created the current process.

Critical()

IMPORT_C TCritical Critical ( ) [static]

Gets the critical state associated with the current thread.

User::SetCritical()

Critical(RThread)

IMPORT_C TCritical Critical ( RThread aThread ) [static]

Gets the critical state associated with the specified thread.

User::SetCritical()

Parameters

RThread aThread The thread whose critical state is to be retrieved.

DoCreatorHasCapability(TCapability, const char *)

IMPORT_C TBool DoCreatorHasCapability ( TCapability aCapability,
const char * aDiagnostic
) [private, static]

Parameters

TCapability aCapability
const char * aDiagnostic

DoCreatorHasCapability(TCapability)

IMPORT_C TBool DoCreatorHasCapability ( TCapability aCapability ) [private, static]

Parameters

TCapability aCapability

DoCreatorHasCapability(TCapability, TCapability, const char *)

IMPORT_C TBool DoCreatorHasCapability ( TCapability aCapability1,
TCapability aCapability2,
const char * aDiagnostic
) [private, static]

Parameters

TCapability aCapability1
TCapability aCapability2
const char * aDiagnostic

DoCreatorHasCapability(TCapability, TCapability)

IMPORT_C TBool DoCreatorHasCapability ( TCapability aCapability1,
TCapability aCapability2
) [private, static]

Parameters

TCapability aCapability1
TCapability aCapability2

ExceptionHandler()

IMPORT_C TExceptionHandler ExceptionHandler ( ) [static]

Gets a pointer to the exception handler for the current thread.

Exit(TInt)

IMPORT_C void Exit ( TInt aReason ) [static]

Terminates the current thread, specifying a reason. All child threads are terminated and all resources are cleaned up.

If the current thread is the main thread in a process, the process is also terminated.

Parameters

TInt aReason The reason code.

FastCounter()

IMPORT_C TUint32 FastCounter ( ) [static]

Gets the fast counter.

This is the current value of the machine's high resolution timer. If a high resolution timer is not available, it uses the millisecond timer instead.

The freqency of this counter can be determined by reading the HAL attribute EFastCounterFrequency.

This function is intended for use in profiling and testing; it should not be used in production code. User::NTickCount() should be used instead.

This is because the implementation of the FastCounter is platform-specific: its frequency can be anywhere from a few KHz to many MHz. It may also not be activated when needed, since it is expensive in terms of clock cycles and battery life, and use of a platform-specific API may be necessary to enable it.

User::NTickCount()

Fold(TUint)

IMPORT_C TUint Fold ( TUint aChar ) [static]

Folds the specified character.

Folding converts the character to a form which can be used in tolerant comparisons without control over the operations performed. Tolerant comparisons are those which ignore character differences like case and accents.

The result of folding a character depends on the locale and on whether this is a UNICODE build or not.

Note that for a non-UNICODE build, if the binary value of the character aChar is greater than or equal to 0x100, then the character returned is the same as the character passed to the function.

TChar::Fold()

Parameters

TUint aChar The character to be folded.

Fold(TUint, TInt)

IMPORT_C TUint Fold ( TUint aChar,
TInt aFlags
) [static]

Folds the character according to a specified folding method.

TChar::EFoldCase , convert characters to their lower case form, if any;

TChar::EFoldAccents , strip accents;

TChar::EFoldDigits , convert digits representing values 0..9 to characters '0'..'9';

TChar::EFoldSpaces , convert all spaces (ordinary, fixed-width, ideographic, etc.) to ' ';

TChar::EFoldKana , convert hiragana to katakana;

TChar::EFoldWidth , fold full width and half width variants to their standard forms;

TChar::EFoldAll , use all of the above folding methods.

TChar::Fold()

Parameters

TUint aChar The character to be folded.
TInt aFlags A set of flags defining the folding method. They are:

Free(TAny *)

IMPORT_C void Free ( TAny * aCell ) [static]

Frees the specified cell and returns it to the current thread's default heap.

panic
USER 42, if aCell is not NULL and does not point to a valid cell.

Parameters

TAny * aCell A pointer to a valid cell to be freed. If NULL this function call will be ignored.

FreeLogicalDevice(const TDesC &)

IMPORT_C TInt FreeLogicalDevice ( const TDesC & aDeviceName ) [static]

Frees the logical device driver DLL associated with a specified driver name.

Parameters

const TDesC & aDeviceName The name of the logical device driver object. This must match the name set during installation of the logical device. Typically, this is done in an implementation of DLogicalDevice::Install() through a call to SetName(). Note that the name is rarely the same as the device's filename. The name of a logical device driver object can be discovered by using TFindLogicalDevice.

FreePhysicalDevice(const TDesC &)

IMPORT_C TInt FreePhysicalDevice ( const TDesC & aDriverName ) [static]

Frees the physical device driver DLL associated with a specified driver name.

Parameters

const TDesC & aDriverName The name of the physical device driver object. This must match the name set during installation of the physical device. Typically, this is done in an implementation of DPhysicalDevice::Install() through a call to SetName(). Note that the name is rarely the same as the device's filename. The name of a physical device driver object can be discovered by using TFindPhysicalDevice.

FreeZ(TAny *&)

IMPORT_C void FreeZ ( TAny *& aCell ) [static]

Frees the specified cell, returns it to the current thread's default heap, and resets the pointer to NULL.

panic
USER 42, if aCell is not NULL and does not point to a valid cell.

Parameters

TAny *& aCell A reference to a pointer to a valid cell to be freed. If NULL this function call will be ignored.

GetDesParameter(TInt, TDes8 &)

IMPORT_C TInt GetDesParameter ( TInt aSlot,
TDes8 & aDes
) [static]

Gets the specified environment data item belonging to the current process; this is assumed to be an 8-bit descriptor.

Environment data may be stored in the process and is passed to a child process on creation of that child process.

On successful return from this function, the data item is deleted from the process.

panic
KERN-EXEC 51, if aSlot is negative or is greater than or equal to 16.

Parameters

TInt aSlot An index that identifies the data item. This is an index whose value is relative to zero; i.e. 0 is the first item/slot. This can range from 0 to 15, i.e. there are 16 slots.
TDes8 & aDes On sucessful return, contains the environment data item; the length of the descriptor is set to the length of the data item.

GetDesParameter(TInt, TDes16 &)

IMPORT_C TInt GetDesParameter ( TInt aSlot,
TDes16 & aDes
) [static]

Gets the specified environment data item belonging to the current process; this is assumed to be an 16-bit descriptor.

Environment data may be stored in the process and is passed to a child process on creation of that child process.

On successful return from this function, the data item is deleted from the process.

panic
KERN-EXEC 51, if aSlot is negative or is greater than or equal to 16.

Parameters

TInt aSlot An index that identifies the data item. This is an index whose value is relative to zero; i.e. 0 is the first item/slot. This can range from 0 to 15, i.e. there are 16 slots.
TDes16 & aDes On sucessful return, contains the environment data item; the length of the descriptor is set to the length of the data item.

GetTIntParameter(TInt, TInt &)

IMPORT_C TInt GetTIntParameter ( TInt aSlot,
TInt & aData
) [static]

Gets the specified environment data item belonging to the current process; this is assumed to be a 32 bit value.

Environment data may be stored in the process and is passed to a child process on creation of that child process.

On successful return from this function, the data item is deleted from the process.

panic
KERN-EXEC 51, if aSlot is negative or is greater than or equal to 16.

Parameters

TInt aSlot An index that identifies the data item. This is an index whose value is relative to zero; i.e. 0 is the first item/slot. This can range from 0 to 15, i.e. there are 16 slots.
TInt & aData On sucessful return, contains the environment data item.

HandleException(TAny *)

IMPORT_C void HandleException ( TAny * aInfo ) [static]

Enables the current thread to handle an exception.

The function is called by the kernel.

TExcType

Parameters

TAny * aInfo A pointer to a TExcType type containing the exception information.

Heap()

RHeap & Heap ( ) [static, inline]

Gets a reference to the handle to the current thread's heap.

IMB_Range(TAny *, TAny *)

IMPORT_C void IMB_Range ( TAny * aStart,
TAny * aEnd
) [static]

Does the necessary preparations to guarantee correct execution of code in the specified virtual address range.

The function assumes that this code has been loaded or modified by user code. Calling this function against uncommitted memory region is considered as S/W bug and may generate exception on some memory models.

The specified addresses are associated with a user writable code chunk as created by RChunk::CreateLocalCode() .

The function cleans the data cache to ensure that written data has been committed to main memory and then flushes the instruction cache and branch target buffer (BTB) to ensure that the code is loaded from main memory when it is executed. The Kernel uses the size of the range specified to decide whether to clean/flush line-by-line or to simply clean/flush the entire cache.

RChunk::CreateLocalCode() UserHeap::ChunkHeap()

Parameters

TAny * aStart The start virtual address of the region.
TAny * aEnd The end virtual address of the region. This location is not within the region.

Identity()

TUid Identity ( ) [static, inline]

InactivityTime()

IMPORT_C TTimeIntervalSeconds InactivityTime ( ) [static]

Gets the time since the last user activity.

InfoPrint(const TDesC &)

IMPORT_C TInt InfoPrint ( const TDesC & aDes ) [static]

Invokes the notifier server to display a text message on the screen for a short time.

RNotifier

Parameters

const TDesC & aDes A reference to the descriptor containing the text to be sent to the notifier server.

InitProcess()

IMPORT_C void InitProcess ( ) [static]

Invariant()

IMPORT_C void Invariant ( ) [static]

Panics the current thread with a USER 0 panic.

Typically, this is called when a test for a class invariant fails, i.e. when a test which checks that the internal data of an object is self-consistent, fails.

Such tests are almost always done in debug builds, commonly using the __ASSERT_DEBUG macro.

IsExceptionHandled(TExcType)

IMPORT_C TBool IsExceptionHandled ( TExcType aType ) [static]

Tests whether the specified exception type can be handled by the current thread.

Parameters

TExcType aType The type of exception.

IsRomAddress(TBool &, TAny *)

IMPORT_C TInt IsRomAddress ( TBool & aBool,
TAny * aPtr
) [static]

Tests whether the specified address is in the ROM.

Parameters

TBool & aBool True, if the address at aPtr is within the ROM; false, otherwise.
TAny * aPtr The address to be tested.

JustInTime()

IMPORT_C TBool JustInTime ( ) [static]

Tests whether just-in-time debugging is on or off.

The function is used by the Kernel, on the Emulator, to decide whether to do just-in-time debugging for panics. The function applies to the current process.

Unless overridden by calling User::SetJustInTime(EFalse), just-in-time debugging is on by default.

RProcess::JustInTime

Language()

IMPORT_C TLanguage Language ( ) [static]

Gets the language of the current locale.

Leave(TInt)

IMPORT_C void Leave ( TInt aReason ) [static]

Leaves the currently executing function, unwinds the call stack, and returns from the most recently entered trap harness.

TRAP TRAPD

Parameters

TInt aReason The value returned from the most recent call to TRAP or TRAPD. This is known as the reason code and, typically, it gives the reason for the environment or user error causing this leave to occur.

LeaveEnd()

IMPORT_C void LeaveEnd ( ) [static]

LeaveIfError(TInt)

IMPORT_C TInt LeaveIfError ( TInt aReason ) [static]

Leaves or returns with a specified reason code.

If the reason code is negative the function leaves, and the reason code is returned through the trap harness.

If the reason code is zero or positive, the function simply returns with the reason value.

Parameters

TInt aReason The reason code.

LeaveIfNull(TAny *)

IMPORT_C TAny * LeaveIfNull ( TAny * aPtr ) [static]

Leaves with the reason code KErrNoMemory, if the specified pointer is NULL.

If the pointer is not NULL, the function simply returns with the value of the pointer.

Parameters

TAny * aPtr The pointer to be tested.

LeaveIfNull(const TAny *)

const TAny * LeaveIfNull ( const TAny * aPtr ) [static, inline]

Leaves with the reason code KErrNoMemory, if the specified pointer is NULL.

If the pointer is not NULL, the function simply returns with the value of the pointer.

Used to check pointers to const objects.

Parameters

const TAny * aPtr The pointer to be tested.

LeaveNoMemory()

IMPORT_C void LeaveNoMemory ( ) [static]

Leaves with the specific reason code KErrNoMemory.

KErrNoMemory

LoadLogicalDevice(const TDesC &)

IMPORT_C TInt LoadLogicalDevice ( const TDesC & aFileName ) [static]

Loads the logical device driver (LDD) DLL with the specified filename.

The function searches the system path for the LDD DLL, and loads it. It then makes a kernel server call that:

1. creates the LDD factory object, an instance of a DLogicalDevice derived class; this involves checking the first UID value to make sure that the DLL is a valid LDD before proceeding to call the exported function at ordinal 1, which creates the LDD factory object on the kernel heap

2. calls the LDD factory object's Install() function to complete the installation

3. adds the new LDD factory object to the kernel's list of LDD factory objects.

Parameters

const TDesC & aFileName A reference to the descriptor containing the name of the physical device driver DLL. If the filename has no extension, .LDD is assumed by default.

LoadPhysicalDevice(const TDesC &)

IMPORT_C TInt LoadPhysicalDevice ( const TDesC & aFileName ) [static]

Loads the physical device driver (PDD) DLL with the specified filename.

The function searches the system path for the PDD DLL, and loads it. It then makes a kernel server call that:

1. creates the PDD factory object, an instance of a DPhysicalDevice derived class; this involves checking the first UID value to make sure that the DLL is a valid PDD before proceeding to call the exported function at ordinal 1, which creates the PDD factory object on the kernel heap

2. calls the PDD factory object's Install() function to complete the installation

2. adds the new PDD factory object to the kernel's list of PDD factory objects.

Parameters

const TDesC & aFileName A reference to the descriptor containing the name of the physical device driver DLL. If the filename has no extension, .PDD is assumed by default.

LockPeriod()

IMPORT_C TTimerLockSpec LockPeriod ( ) [static]

Returns which of the periods the clock is currently in.

LockedDec(TInt &)

IMPORT_C TInt LockedDec ( TInt & aValue ) [static]

Atomically (i.e. in a manner which is safe against concurrent access by other threads) decrements a TInt value by 1.

As an example of its use, the function is used in the implementation of critical sections.

User::LockedInc RCrticalSection

Parameters

TInt & aValue A reference to an integer whose value is to be decremented. On return contains the decremented value.

LockedInc(TInt &)

IMPORT_C TInt LockedInc ( TInt & aValue ) [static]

Atomically (i.e. in a manner which is safe against concurrent access by other threads) increments a TInt value by 1.

As an example of its use, the function is used in the implementation of critical sections.

User::LockedDec RCrticalSection

Parameters

TInt & aValue A reference to an integer whose value is to be incremented. On return contains the incremented value.

LowerCase(TUint)

IMPORT_C TUint LowerCase ( TUint aChar ) [static]

Converts the specified character to lower case.

The result of the conversion depends on the locale and on whether this is a UNICODE build or not.

Note that for a non-UNICODE build, if the binary value of the character aChar is greater than or equal to 0x100, then the character returned is the same as the character passed to the function.

Parameters

TUint aChar The character to be converted to lower case.

MachineConfiguration(TDes8 &, TInt &)

IMPORT_C TInt MachineConfiguration ( TDes8 & aConfig,
TInt & aSize
) [static]

Gets the machine configuration.

capability
ReadDeviceData

Parameters

TDes8 & aConfig On return contains the machine configuration data.
TInt & aSize On return, contains the size of the data.

MarkCleanupStack()

IMPORT_C TTrapHandler * MarkCleanupStack ( ) [static]

If there's a TTrapHandler installed marks the cleanup stack and returns the TTrapHandler for subsequent use in UnMarkCleanupStack.

Only intended for use in the defintion of TRAP and TRAPD and only when User::Leave is defined in terms of THROW.

TRAP TRAPD

ModifyExceptionMask(TUint32, TUint32)

IMPORT_C void ModifyExceptionMask ( TUint32 aClearMask,
TUint32 aSetMask
) [static]

Changes the set of exceptions which the current thread's exception handler can deal with.

aClearMask is the set of flags defining the set of exceptions which the exception handler no longer deals with, while aSetMask is the set of flags defining the new set of exceptions to be set.

Flag clearing is done before flag setting.

Parameters

TUint32 aClearMask One or more flags defining the exceptions which the current exception handler no longer deals with.
TUint32 aSetMask One or more flags defining the new set of exceptions which the current exception handler is to deal with.

NTickCount()

IMPORT_C TUint32 NTickCount ( ) [static]

Gets the nanokernel tick count.

This is the current value of the machine's millisecond tick counter.

On the emulator the resolution defaults to 5 milliseconds; however you can change it to N milliseconds when you launch the emulator from the command line by specifying -Dtimerresolution=N as a parameter to epoc.exe, for example:
         epoc.exe -Dtimerresolution=3
        

On most hardware the resolution is about 1 millisecond.

You can get the nanokernel tick period in microseconds by calling into the Hardware Abstraction Layer:

         TInt nanokernel_tick_period;
HAL::Get(HAL::ENanoTickPeriod, nanokernel_tick_period);
        

NotifyOnIdle(TRequestStatus &)

IMPORT_C void NotifyOnIdle ( TRequestStatus & aStatus ) [static]

Queue a notifier to detect system idle

Parameters

TRequestStatus & aStatus

Panic(const TDesC &, TInt)

IMPORT_C void Panic ( const TDesC & aCategory,
TInt aReason
) [static]

Panics the current thread, specifying a category name and panic number.

Keep the length of the category name small; it is limited to 16 characters.

Parameters

const TDesC & aCategory A reference to the descriptor containing the text that defines the category for this panic.
TInt aReason The panic number.

PanicUnexpectedLeave()

IMPORT_C void PanicUnexpectedLeave ( ) [static]

ParameterLength(TInt)

IMPORT_C TInt ParameterLength ( TInt aSlot ) [static]

Gets the length of the specified item of environment data belonging to the current process.

Environment data may be stored in the process and is passed to a child process on creation of that child process.

panic
KERN-EXEC 51, if aSlot is negative or is greater than or equal to 16.

Parameters

TInt aSlot An index that identifies the data item whose length is to be retrieved. This is an index whose value is relative to zero; i.e. 0 is the first item/slot. This can range from 0 to 15, i.e. there are 16 slots.

PriorityControl()

IMPORT_C TBool PriorityControl ( ) [static]

Tests whether the current process allows other processes to switch its priority between 'foreground' and 'background'.

ProcessCritical()

IMPORT_C TCritical ProcessCritical ( ) [static]

Gets the critical state associated with the current process.

User::SetProcessCritical()

ProcessCritical(RProcess)

IMPORT_C TCritical ProcessCritical ( RProcess aProcess ) [static]

Gets the critical state associated with the specified process.

User::SetProcessCritical()

Parameters

RProcess aProcess The process whose critical state is to be retrieved.

QueryVersionSupported(const TVersion &, const TVersion &)

IMPORT_C TBool QueryVersionSupported ( const TVersion & aCurrent,
const TVersion & aRequested
) [static]

Compares two version objects and returns true if the test version is less than the current version.

Version information is encapsulated by a TVersion type object and consists of a major version number, a minor version number and a build number.

The function returns true if one of the following conditions is true:

1. the test major version is strictly less than the current major version

2. the test major version is equal to the current major version and the test minor version is less than or equal to the current minor version

If neither condition is true, the function returns false.

Parameters

const TVersion & aCurrent A reference to the current version against which aRequested is compared.
const TVersion & aRequested A reference to the test version to be compared against aCurrent.

QuickSort(TInt, const TKey &, const TSwap &)

IMPORT_C TInt QuickSort ( TInt aCount,
const TKey & aKey,
const TSwap & aSwap
) [static]

Quick sorts array elements.

It is used by the standard Symbian OS arrays having CArrayFixBase , CArrayVarBase or CArrayPakBase in their class hierarchy in the implementation of their sort functions. The function can be used by other arrays.

The function returns KErrNone if the operation is successful otherwise it returns KErrGeneral.

panic
USER 96, if aCount is negative.

Parameters

TInt aCount The number of elements in the array.
const TKey & aKey A reference to a suitably initialised TKey derived object.
const TSwap & aSwap A reference to a suitably initialised TSwap derived object.

RaiseException(TExcType)

IMPORT_C TInt RaiseException ( TExcType aType ) [static]

Raises an exception of a specified type on the current thread.

If the thread has an exception handler to handle this type of exception, then it is called.

If the thread has no exception handler to handle this type of exception, then the function raises a USER-EXEC 3 panic.

Note that exception handlers are executed in the context of the thread on which the exception is raised; control returns to the point of the exception.

Parameters

TExcType aType The type of exception.

ReAlloc(TAny *, TInt, TInt)

IMPORT_C TAny * ReAlloc ( TAny * aCell,
TInt aSize,
TInt aMode = 0
) [static]

Increases or decreases the size of an existing cell in the current thread's heap.

If the cell is being decreased in size, then it is guaranteed not to move, and the function returns the pointer originally passed in aCell. Note that the length of the cell will be the same if the difference between the old size and the new size is smaller than the minimum cell size.

If the cell is being increased in size, i.e. aSize is bigger than its current size, then the function tries to grow the cell in place. If successful, then the function returns the pointer originally passed in aCell. If unsuccessful, then:
  1. if the cell cannot be moved, i.e. aMode has the ENeverMove bit set, then the function returns NULL.

  2. if the cell can be moved, i.e. aMode does not have the ENeverMove bit set, then the function tries to allocate a new replacement cell, and, if successful, returns a pointer to the new cell; if unsuccessful, it returns NULL.

Note that in debug mode, the function returns NULL if the cell cannot be grown in place, regardless of whether the ENeverMove bit is set.

If the reallocated cell is at a different location from the original cell, then the content of the original cell is copied to the reallocated cell.

If the supplied pointer, aCell is NULL, then the function attempts to allocate a new cell, but only if the cell can be moved, i.e. aMode does not have the ENeverMove bit set.

Note the following general points:
  • If reallocation fails, the content of the original cell is preserved.

  • The resulting size of the re-allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.

panic
USER 42, if aCell is not NULL, and does not point to a valid cell.
panic
USER 47, if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling ReAlloc(someptr,-1) raises this panic.
RAllocator::TReAllocMode

Parameters

TAny * aCell A pointer to the cell to be reallocated. This may be NULL.
TInt aSize The new size of the cell. This may be bigger or smaller than the size of the original cell. The value can also be zero, but this is interpreted as a request for a cell of minimum size; the net effect is the same as if the caller had explicitly requested a cell of minimum size. Note that the minimum size of a heap cell is device dependent.
TInt aMode = 0 Flags controlling the reallocation. The only bit which has any effect on this function is that defined by the enumeration ENeverMove of the enum RAllocator::TReAllocMode. If this is set, then any successful reallocation guarantees not to have changed the start address of the cell. By default, this parameter is zero.

ReAllocL(TAny *, TInt, TInt)

IMPORT_C TAny * ReAllocL ( TAny * aCell,
TInt aSize,
TInt aMode = 0
) [static]

Increases or decreases the size of an existing cell, and leaves if there is insufficient memory in the current thread's default heap.

If the cell is being decreased in size, then it is guaranteed not to move, and the function returns the pointer originally passed in aCell. Note that the length of the cell will be the same if the difference between the old size and the new size is smaller than the minimum cell size.

If the cell is being increased in size, i.e. aSize is bigger than its current size, then the function tries to grow the cell in place. If successful, then the function returns the pointer originally passed in aCell. If unsuccessful, then:
  1. if the cell cannot be moved, i.e. aMode has the ENeverMove bit set, then the function leaves.

  2. if the cell can be moved, i.e. aMode does not have the ENeverMove bit set, then the function tries to allocate a new replacement cell, and, if successful, returns a pointer to the new cell; if unsuccessful, it leaves.

Note that in debug mode, the function leaves if the cell cannot be grown in place, regardless of whether the ENeverMove bit is set.

If the reallocated cell is at a different location from the original cell, then the content of the original cell is copied to the reallocated cell.

If the supplied pointer, aCell is NULL, then the function attempts to allocate a new cell, but only if the cell can be moved, i.e. aMode does not have the ENeverMove bit set.

Note the following general points:
  • If reallocation fails, the content of the original cell is preserved.

  • The resulting size of the re-allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.

panic
USER 42, if aCell is not NULL, and does not point to a valid cell.
panic
USER 47, if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling ReAlloc(someptr,-1) raises this panic.
RAllocator::TReAllocMode

Parameters

TAny * aCell A pointer to the cell to be reallocated. This may be NULL.
TInt aSize The new size of the cell. This may be bigger or smaller than the size of the original cell. The value can also be zero, but this is interpreted as a request for a cell of minimum size; the net effect is the same as if the caller had explicitly requested a cell of minimum size. Note that the minimum size of a heap cell is device dependent.
TInt aMode = 0 Flags controlling the reallocation. The only bit which has any effect on this function is that defined by the enumeration ENeverMove of the enum RAllocator::TReAllocMode. If this is set, then any successful reallocation guarantees not to have changed the start address of the cell. By default, this parameter is zero.

RegionCode()

IMPORT_C TRegionCode RegionCode ( ) [static]

RenameProcess(const TDesC &)

IMPORT_C TInt RenameProcess ( const TDesC & aName ) [static]

Assigns a new name to the current process, replacing any existing name.

When a process is created, its default name is the name portion of the filename from which the executable is loaded.

The new name must be a valid name and it must also be such that the process's new fullname remains unique amongst processes.

Parameters

const TDesC & aName A reference to the descriptor containing the new name of the process.

RenameThread(const TDesC &)

IMPORT_C TInt RenameThread ( const TDesC & aName ) [static]

Assigns a new name to the current thread, replacing any existing name that may have been set.

The new name must be a valid name and it must also be such that the thread's new fullname remains unique amongst threads. The length of the new name must be less than or equal to 80 (maximum length of kernel objects) otherwise a panic is raised.

Parameters

const TDesC & aName A reference to the descriptor containing the new name for the thread.

RequestComplete(TRequestStatus *&, TInt)

IMPORT_C void RequestComplete ( TRequestStatus *& aStatus,
TInt aReason
) [static]

Signals the current thread that the asynchronous request associated with the specified request status object is complete.

This function is used to complete an asynchronous request originating in the same thread as the code that is currently executing. If a request originates in another thread, then executing code must use RThread::RequestComplete() to signal the completion of that request.

The request is completed with the completion code passed in aReason. This value is copied into the request status, pointed to by aStatus, before signalling the current thread's request semaphore.

The meaning of the completion code passed in aReason is a matter of convention to be decided between the service requester and the service provider.

RThread::RequestComplete

Parameters

TRequestStatus *& aStatus A reference to a pointer to the request status object. This is a pointer into the current thread's address space. On return, the pointer to the request status is set to NULL. Note that setting the pointer to NULL is a convenience, not all servers need it, and is done before the function returns.
TInt aReason The completion code of this request.

ResetInactivityTime()

IMPORT_C void ResetInactivityTime ( ) [static]

Resets all user inactivity timers.

SafeDec(TInt &)

IMPORT_C TInt SafeDec ( TInt & aValue ) [static]

Atomically decrements the specified value by 1, if the value is > 0.

Parameters

TInt & aValue The value to be decremented; on return the decremented value.

SafeInc(TInt &)

IMPORT_C TInt SafeInc ( TInt & aValue ) [static]

Atomically increments the specified value by 1, if the value is > 0.

Parameters

TInt & aValue The value to be incremented; on return the incremented value.

SetCritical(TCritical)

IMPORT_C TInt SetCritical ( TCritical aCritical ) [static]

Sets up or changes the effect that termination of the current thread has, either on its owning process, or on the whole system.

The precise effect of thread termination is defined by the following specific values of the TCritical enum:
  • ENotCritical

  • EProcessCritical

  • EProcessPermanent

  • ESystemCritical

  • ESystemPermanent

Notes:
  1. The enum value EAllThreadsCritical cannot be set using this function. It is associated with a process, not a thread, and, if appropriate, should be set using User::SetProcessCritical() .

  2. The states associated with ENotCritical, EProcessCritical, EProcessPermanent, ESystemCritical and ESystemPermanent are all mutually exclusive, i.e. the thread can only be in one of these states at any one time

capability
ProtServ if aCritical==ESystemCritical or ESystemPermanent
User::Critical() User::ProcessCritical() User::SetProcessCritical()

Parameters

TCritical aCritical The state to be set.

SetCurrencySymbol(const TDesC &)

IMPORT_C TInt SetCurrencySymbol ( const TDesC & aSymbol ) [static]

Sets the system wide currency symbol.

On successful return from this function, a call to the Set() member function of a TCurrencySymbol object fetches the new currency symbol.

capability
WriteDeviceData
panic
USER 119, if the length of aSymbol is greater than KMaxCurrencySymbol.
TCurrencySymbol TCurrencySymbol::Set() KMaxCurrencySymbol

Parameters

const TDesC & aSymbol A reference to the descriptor containing the currency symbol to be set.

SetDebugMask(TUint32)

IMPORT_C void SetDebugMask ( TUint32 aVal ) [static]

Sets the debug mask.

Parameters

TUint32 aVal A set of bit values as defined in nk_trace.h

SetDebugMask(TUint32, TUint)

IMPORT_C void SetDebugMask ( TUint32 aVal,
TUint aIndex
) [static]

Sets the debug mask at the given index

Parameters

TUint32 aVal A set of bit values as defined in nk_trace.h
TUint aIndex An index of which 32 bit mask word is to be accessed

SetExceptionHandler(TExceptionHandler, TUint32)

IMPORT_C TInt SetExceptionHandler ( TExceptionHandler aHandler,
TUint32 aMask
) [static]

Sets a new exception handler for the current thread. Note that the handler is not guaranteed to receive floating point exceptions (KExceptionFpe) when a hardware floating point implementation is in use - see User::SetFloatingPointMode for hardware floating point modes and whether they cause user-trappable exceptions.

KExceptionAbort KExceptionKill KExceptionUserInterrupt KExceptionFpe KExceptionFault KExceptionInteger KExceptionDebug

Parameters

TExceptionHandler aHandler The new exception handler.
TUint32 aMask One or more flags defining the exception categories which the handler can handle.

SetFloatingPointMode(TFloatingPointMode, TFloatingPointRoundingMode)

IMPORT_C TInt SetFloatingPointMode ( TFloatingPointMode aMode,
TFloatingPointRoundingMode aRoundingMode = EFpRoundToNearest
) [static]

Sets the hardware floating point mode for the current thread. This does not affect software floating point calculations. The rounding mode can also be set. New threads created by this thread will inherit the mode, thus to set the mode for a whole process, call this method before you create any new threads.

TFloatingPointMode TFloatingPointRoundingMode

Parameters

TFloatingPointMode aMode The floating point calculation mode to use.
TFloatingPointRoundingMode aRoundingMode = EFpRoundToNearest The floating point rounding mode to use, defaults to nearest.

SetHomeTime(const TTime &)

IMPORT_C TInt SetHomeTime ( const TTime & aTime ) [static]

Sets the home time to a specified time value.

Set the time using User::SetUTCTime if the UTC time is known; otherwise, use the timezone server to set the time.

capability
WriteDeviceData

Parameters

const TTime & aTime A reference to a time representation object containing the time value.

SetHomeTimeSecure(const TTime &)

IMPORT_C TInt SetHomeTimeSecure ( const TTime & aTime ) [static]

Sets the secure home time to a specified time value.

capability
TCB
capability
WriteDeviceData

Parameters

const TTime & aTime A reference to a time representation object containing the secure time value.

SetJustInTime(const TBool)

IMPORT_C void SetJustInTime ( const TBool aBoolean ) [static]

Sets just-in-time debugging for this process on or off.

While the function can be called by code running on both the Emulator and ARM, it only has an effect on the Emulator. Turning just-in-time debugging off prevents the debug Emulator closing down when a panic occurs.

By default, just-in-time debugging is on.

Note that the emulator handles panics in the nomal manner, i.e. by killing the thread.

RProcess::SetJustInTime

Parameters

const TBool aBoolean ETrue, if just-in-time debugging is to be set on. EFalse, if just-in-time debugging is to be set off. EFalse causes _asm 3 calls to be disabled.

SetMachineConfiguration(const TDesC8 &)

IMPORT_C TInt SetMachineConfiguration ( const TDesC8 & aConfig ) [static]

Sets the machine configuration.

capability
WriteDeviceData

Parameters

const TDesC8 & aConfig Descriptor containing the machine configuration data

SetPriorityControl(TBool)

IMPORT_C void SetPriorityControl ( TBool aEnable ) [static]

Allows the current process to choose to have its priority switched by another process between 'foreground' and 'background'.

By default a process does not allow this.

Parameters

TBool aEnable If ETrue, allows other processes to switch the current process's priority. If EFalse, prevents other processes from switching the current process's priority.

SetProcessCritical(TCritical)

IMPORT_C TInt SetProcessCritical ( TCritical aCritical ) [static]

Sets up or changes the effect that termination of subsequently created threads will have, either on the owning process, or on the whole system.

It is important to note that we are not referring to threads that have already been created, but threads that will be created subsequent to a call to this function.

The precise effect of thread termination is defined by the following specific values of the TCritical enum:
  • ENotCritical

  • EAllThreadsCritical

  • ESystemCritical

  • ESystemPermanent

Notes:
  1. The enum values EProcessCritical and EProcessPermanent cannot be set using this function. They are states associated with a thread, not a process, and, if appropriate, should be set using User::SetCritical() .

  2. The states associated with ENotCritical, EAllThreadsCritical, ESystemCritical and ESystemPermanent are all mutually exclusive, i.e. the process can only be in one of these states at any one time.

capability
ProtServ if aCritical==ESystemCritical or ESystemPermanent
User::ProcessCritical() User::SetCritical() User::Critical()

Parameters

TCritical aCritical The state to be set.

SetRealtimeState(TRealtimeState)

IMPORT_C TInt SetRealtimeState ( TRealtimeState aState ) [static]

Set the current threads realtime state. TRealtimeState

Parameters

TRealtimeState aState The state

SetTrapHandler(TTrapHandler *)

IMPORT_C TTrapHandler * SetTrapHandler ( TTrapHandler * aHandler ) [static]

Sets the current thread's trap handler and returns a pointer to any pre-existing trap handler.

Pass a NULL pointer to this function to clear the trap handler.

The trap handler works with the TRAP mechanism to handle the effects of a leave.

Note that TTrapHandler is an abstract base class; a trap handler must be implemented as a derived class.

TRAP TRAPD

Parameters

TTrapHandler * aHandler A pointer to the trap handler which is to be installed as the current thread's trap handler.

SetUTCOffset(TTimeIntervalSeconds)

IMPORT_C void SetUTCOffset ( TTimeIntervalSeconds aOffset ) [static]

Sets the UTC offset to the given number of seconds. This should include both time zone differences and the effect of any applicable daylight savings time. A positive offset indicates a time ahead of UTC, a negative offset indicates a time behind UTC.

capability
WriteDeviceData

Parameters

TTimeIntervalSeconds aOffset The UTC offset, in seconds.

SetUTCTime(const TTime &)

IMPORT_C TInt SetUTCTime ( const TTime & aUTCTime ) [static]

Sets the UTC time to a specified time value.

capability
WriteDeviceData

Parameters

const TTime & aUTCTime A reference to a time representation object containing the time value.

SetUTCTimeAndOffset(const TTime &, TTimeIntervalSeconds)

IMPORT_C TInt SetUTCTimeAndOffset ( const TTime & aUTCTime,
TTimeIntervalSeconds aOffset
) [static]

Sets the UTC time and UTC offset to the specified values, atomically. This is equivalent to calling both SetUTCTime and SetUTCOffset, but without the possibility of an incorrect time being observed between the two calls. If the operation is not successful, an error code will be returned and both the time and offset will be left unchanged.

capability
WriteDeviceData

Parameters

const TTime & aUTCTime A reference to a time representation object containing the time value.
TTimeIntervalSeconds aOffset The UTC offset, in seconds.

SetUTCTimeSecure(const TTime &)

IMPORT_C TInt SetUTCTimeSecure ( const TTime & aUTCTime ) [static]

Sets the secure UTC time to a specified time value.

capability
TCB
capability
WriteDeviceData

Parameters

const TTime & aUTCTime A reference to a time representation object containing the secure time value.

StringLength(const TUint8 *)

IMPORT_C TInt StringLength ( const TUint8 * aString ) [static]

Gets the length of a C style, null terminated, string of single-byte valued characters.

The length does not include the null terminator.

Parameters

const TUint8 * aString A pointer to the single byte valued, null terminated, string.

StringLength(const TUint16 *)

IMPORT_C TInt StringLength ( const TUint16 * aString ) [static]

Gets the length of a C style, null terminated, string of double-byte valued characters.

The length does not include the null terminator.

Parameters

const TUint16 * aString A pointer to the double-byte valued, null terminated, string.

SwitchAllocator(RAllocator *)

IMPORT_C RAllocator * SwitchAllocator ( RAllocator * aAllocator ) [static]

Changes the current thread's heap.

Parameters

RAllocator * aAllocator A pointer to the new heap handle.

SwitchHeap(RAllocator *)

RHeap * SwitchHeap ( RAllocator * aHeap ) [static, inline]

Changes the current thread's heap.

Parameters

RAllocator * aHeap A pointer to the new heap handle.

TickCount()

IMPORT_C TUint TickCount ( ) [static]

Gets the current tick count.

The period between ticks is usually 1/64 second, but may be hardware dependent.

TitleCase(TUint)

IMPORT_C TUint TitleCase ( TUint aChar ) [static]

Converts a specified character to its title case version.

Parameters

TUint aChar The character to be converted.

TrapHandler()

IMPORT_C TTrapHandler * TrapHandler ( ) [static]

Gets a pointer to the current thread's trap handler.

Note that TTrapHandler is an abstract base class; a trap handler must be implemented as a derived class.

UTCOffset()

IMPORT_C TTimeIntervalSeconds UTCOffset ( ) [static]

Gets the UTC offset - the difference between UTC and the current local time due to any time zones and daylight savings time that may be in effect. A positive offset indicates a time ahead of UTC, a negative offset indicates a time behind UTC.

UnMarkCleanupStack(TTrapHandler *)

IMPORT_C void UnMarkCleanupStack ( TTrapHandler * aHandler ) [static]

If passed a non-null TTrapHandler unmarks the cleanup stack.

Only intended for use in the defintion of TRAP and TRAPD and only when User::Leave is defined in terms of THROW.

TRAP TRAPD

Parameters

TTrapHandler * aHandler

UpperCase(TUint)

IMPORT_C TUint UpperCase ( TUint aChar ) [static]

Converts a specified character to upper case.

The result of the conversion depends on the locale and on whether this is a UNICODE build or not.

Note that for a non UNICODE build, if the binary value of the character aChar is greater than or equal to 0x100, then the character returned is the same as the character passed to the function.

Parameters

TUint aChar The character to be converted to upper case.

ValidateName(const TDesC &)

IMPORT_C TInt ValidateName ( const TDesC & aName ) [static]

Checks whether a specified name is a valid CObject name.

A name is deemed to be invalid, if it contains any of the characters: "*", "?", ":" i.e. the characters: asterisk, question mark and single colon.

CObject

Parameters

const TDesC & aName A reference to the descriptor containing the name to be checked.

Version()

IMPORT_C TVersion Version ( ) [static]

Retrieves the E32 component version number, which is the kernel architecture version number. For example for EKA2 the major part of the version number will be 2.

WaitForAnyRequest()

IMPORT_C void WaitForAnyRequest ( ) [static]

Waits for any asynchronous request to complete.

The current thread waits on its request semaphore.

The function completes, and control returns to the caller when the current thread's request semaphore is signalled by any of the service providers which handle these asynchronous requests.

The request status of all outstanding asynchronous requests must be examined to determine which request is complete.

TRequestStatus

WaitForNRequest(TRequestStatus *, TInt)

IMPORT_C void WaitForNRequest ( TRequestStatus * aStatusArray,
TInt aNum
) [static]

Waits for any one of specific asynchronous requests to complete.

The current thread waits on its request semaphore.

The function completes and control returns to the caller when the current thread's request semaphore is signalled by the service provider handling the request associated with any member of aStatusArray[]. Before signalling, the completing service provider sets an appropriate value in the status object, other than KRequestPending.

Note that if other asynchronous requests complete before the ones associated with aStatusArray the request semaphore is adjusted so that knowledge of their completion is not lost. In this a case, a subsequent call to User::WaitForAnyRequest() or User::WaitForRequest() will complete and return immediately.

Parameters

TRequestStatus * aStatusArray
TInt aNum

WaitForRequest(TRequestStatus &)

IMPORT_C void WaitForRequest ( TRequestStatus & aStatus ) [static]

Waits for a specific asynchronous request to complete.

The current thread waits on its request semaphore.

The function completes and control returns to the caller when the current thread's request semaphore is signalled by the service provider handling the request associated with aStatus. Before signalling, the service provider sets an appropriate value in aStatus, other than KRequestPending.

Note that if other asynchronous requests complete before the one associated with aStatus, the request semaphore is adjusted so that knowledge of their completion is not lost. In this a case, a subsequent call to User::WaitForAnyRequest() or User::WaitForRequest() will complete and return immediately.

KRequestPending

Parameters

TRequestStatus & aStatus A reference to the request status object associated with the specific asynchronous request.

WaitForRequest(TRequestStatus &, TRequestStatus &)

IMPORT_C void WaitForRequest ( TRequestStatus & aStatus1,
TRequestStatus & aStatus2
) [static]

Waits for either of two specific asynchronous requests to complete.

The current thread waits on its request semaphore.

The function completes and control returns to the caller when the current thread's request semaphore is signalled by either the service provider handling the request associated with aStatus1 or the service provider handling the request associated with aStatus2. Before signalling, the completing service provider sets an appropriate value in the status object, other than KRequestPending.

Note that if other asynchronous requests complete before the ones associated with aStatus1 and aStatus2, the request semaphore is adjusted so that knowledge of their completion is not lost. In this a case, a subsequent call to User::WaitForAnyRequest() or User::WaitForRequest() will complete and return immediately.

KRequestPending

Parameters

TRequestStatus & aStatus1 A reference to the request status object associated with the first specific asynchronous request.
TRequestStatus & aStatus2 A reference to the request status object associated with the second specific asynchronous request.

__DbgCheckFailure(TBool)

IMPORT_C TUint __DbgCheckFailure ( TBool aKernel ) [static]

Returns the number of heap allocation failures the current debug allocator fail function has caused so far.

This is intended to only be used with fail types RAllocator::EFailNext , RAllocator::EBurstFailNext , RAllocator::EDeterministic and RAllocator::EBurstDeterministic . The return value is unreliable for all other fail types.

RAllocator::TAllocFail

Parameters

TBool aKernel

__DbgMarkCheck(TBool, TBool, TInt, const TUint8 *, TInt)

IMPORT_C void __DbgMarkCheck ( TBool aKernel,
TBool aCountAll,
TInt aCount,
const TUint8 * aFileName,
TInt aLineNum
) [static]

Checks the current number of allocated heap cells for the current thread's default heap, or the kernel heap.

If aCountAll is true, the function checks that the total number of allocated cells on the heap is the same as aCount. If aCountAll is false, the function checks that the number of allocated cells at the current nested level is the same as aCount.

If checking fails, the function raises a panic. Information about the failure is put into the panic category, which takes the form:

ALLOC COUNT\rExpected aaa\rAllocated bbb\rLn: ccc ddd

Where aaa is the value aCount, bbb is the number of allocated heap cells, ccc is a line number, copied from aLineNum, and ddd is a file name, copied from the descriptor aFileName.

Note that the panic number is 1.

Parameters

TBool aKernel ETrue, if checking is being done for the kernel heap; EFalse, if checking is being done for the current thread's default heap.
TBool aCountAll If true, the function checks that the total number of allocated cells on the heap is the same as aCount. If false, the function checks that the number of allocated cells at the current nested level is the same as aCount.
TInt aCount The expected number of allocated cells.
const TUint8 * aFileName A filename; this is displayed as part of the panic category, if the check fails.
TInt aLineNum A line number; this is displayed as part of the panic category, if the check fails.

__DbgMarkEnd(TBool, TInt)

IMPORT_C TUint32 __DbgMarkEnd ( TBool aKernel,
TInt aCount
) [static]

Marks the end of heap cell checking at the current nested level for the current thread's default heap, or the kernel heap.

The function checks that the number of heap cells allocated, at the current nested level, is aCount. The most common value for aCount is zero, reflecting the fact that the most common requirement is to check that all memory allocated since a previous call to __DbgStartCheck() has been freed.

A call to this function should match an earlier call to __DbgMarkStart() . If there are more calls to this function than calls to __DbgMarkStart() , then this function raises a USER 51 panic.

If the check fails for a user heap, the function raises an ALLOC: nnnnnnnn panic, where nnnnnnnn is a hexadecimal pointer to the first orphaned heap cell.

If the check fails for the kernel heap, the kernel server raises a KERN-EXEC 17 panic.

Parameters

TBool aKernel ETrue, if checking is being done for the kernel heap; EFalse, if checking is being done for the current thread's default heap.
TInt aCount The number of allocated heap cells expected.

__DbgMarkStart(TBool)

IMPORT_C void __DbgMarkStart ( TBool aKernel ) [static]

Marks the start of heap cell checking for the current thread's default heap, or for the kernel heap.

If earlier calls to __DbgMarkStart() have been made, then this call to __DbgMarkStart() marks the start of a new nested level of heap cell checking.

Every call to __DbgMarkStart() should be matched by a later call to __DbgMarkEnd() to verify that the number of heap cells allocated, at the current nested level, is as expected. This expected number of heap cells is passed to __DbgMarkEnd() as a parameter; however, the most common expected number is zero, reflecting the fact that the most common requirement is to check that all memory allocated since a previous call to __DbgStartCheck() has been freed.

Parameters

TBool aKernel ETrue, if checking is being done for the kernel heap; EFalse, if checking is being done for the current thread's default heap.

__DbgSetAllocFail(TBool, RAllocator::TAllocFail, TInt)

IMPORT_C void __DbgSetAllocFail ( TBool aKernel,
RAllocator::TAllocFail aFail,
TInt aRate
) [static]

Simulates a heap allocation failure for the current thread's default heap, or the kernel heap.

The failure occurs on subsequent calls to new or any of the functions which allocate memory from the heap.

The timing of the allocation failure depends on the type of allocation failure requested, i.e. on the value of aType.

The simulation of heap allocation failure is cancelled if aType is given the value RAllocator::ENone .

Notes:

1. If the failure type is RHeap::EFailNext , the next attempt to allocate from the heap fails; however, no further failures will occur.

2. For failure types RHeap::EFailNext and RHeap::ENone , set aRate to 1.

Parameters

TBool aKernel ETrue, if checking is being done for the kernel heap; EFalse, if checking is being done for the current thread's default heap.
RAllocator::TAllocFail aFail An enumeration which indicates how to simulate heap allocation failure.
TInt aRate The rate of failure; when aType is RAllocator::EDeterministic, heap allocation fails every aRate attempts.

__DbgSetBurstAllocFail(TBool, RAllocator::TAllocFail, TUint, TUint)

IMPORT_C void __DbgSetBurstAllocFail ( TBool aKernel,
RAllocator::TAllocFail aFail,
TUint aRate,
TUint aBurst
) [static]

Simulates a heap allocation failure for the current thread's default heap, or the kernel heap.

The aBurst failures will occur after subsequent calls to new or any of the functions which allocate memory from the heap.

The timing of the allocation failures will depend on the type of allocation failure requested, i.e. on the value of aType.

The simulation of heap allocation failure is cancelled if aType is given the value RAllocator::ENone .

Parameters

TBool aKernel ETrue, if checking is being done for the kernel heap; EFalse, if checking is being done for the current thread's default heap.
RAllocator::TAllocFail aFail An enumeration which indicates how to simulate heap allocation failure.
TUint aRate The rate of failure; when aType is RAllocator::EDeterministic, heap allocation fails every aRate attempts.
TUint aBurst The number of consecutive allocations that should fail.

Member Enumerations Documentation

Enum TCritical

A set of values that defines the effect that terminating a thread has, either on its owning process or on the whole system.

A thread is said to be critical if its owning process or the entire system terminates when the thread itself terminates.

You pass one of these values to the functions:

The meaning of a value when passed to one function is different to its meaning when passed the other function. See the description of each individual value.

User::SetCritical() User::SetProcessCritical()

Enumerators

ENotCritical
This value can be passed to both:
  • User::SetCritical() , which means that the current thread is no longer critical, i.e. termination of the current thread will no longer cause termination of the current thread's owning process (i.e. the current process) or a reboot of the system.

  • User::SetProcessCritical() , which means that threads subsequently created in the current thread's owning process (i.e. the current process) will no longer cause termination of that process or a reboot of the system. Note, however, that existing threads are NOT affected when you call this function.

User::SetCritical() User::SetProcessCritical()

EProcessCritical

This value can only be passed to User::SetCritical() and affects the current thread only.

It means that the owning process (i.e.the current process) terminates if:
  • the current thread is terminated.

  • the current thread panics.

User::SetCritical()

EProcessPermanent

This value can only be passed to User::SetCritical() and affects the current thread only.

It means that the owning process (i.e.the current process) terminates if the current thread terminates for any reason.

User::SetCritical()

EAllThreadsCritical

This value can only be passed to User::SetProcessCritical() and affects any new threads created in the current process.

It means that the current process terminates if:
  • any new thread subsequently created in the current process is terminated.

  • any new thread subsequently created in the current process panics.

Note, however, that existing threads in the current process are NOT affected when you call User::SetProcessCritical() with this value.

EProcessCritical User::SetProcessCritical()

ESystemCritical

This value can be passed to both: User::SetCritical() and User::SetProcessCritical() .

When passed to User::SetCritical() , it means that the entire system is rebooted if:
  • the current thread is terminated.

  • the current thread panics.

When passed to User::SetProcessCritical() , it means that the entire system is rebooted if:
  • any new thread subsequently created in the current process is terminated.

  • any new thread subsequently created in the current process panics.

  • the process itself is terminated

  • the process itself panics

Note:
  1. existing threads in the current process are NOT affected when you call User::SetProcessCritical() with this value.

  2. Only a process with 'Protected Server' capability can set a thread to system-critical.

User::SetCritical() User::SetProcessCritical()

ESystemPermanent

This value can be passed to both: User::SetCritical() and User::SetProcessCritical() .

When passed to User::SetCritical() , it means that the entire system is rebooted if the current thread exits for any reason.

When passed to User::SetProcessCritical() , it means that the entire system is rebooted if any new thread subsequently created in the current process exits for any reason, or if the process itself exits for any reason.

Note:
  1. existing threads in the current process are NOT affected when you call User::SetProcessCritical() with this value.

  2. Only a process with 'Protected Server' capability can set a thread to system-permanent.

User::SetCritical() User::SetProcessCritical()

Enum TRealtimeState

A threads realtime state. Some non-realtime behaviour can be detected by the kernel. When it does so, action is taken depending on the thread state:
  • ERealtimeStateOff - no action.

  • ERealtimeStateOn - the the thread will be panicked with KERN-EXEC 61 (EIllegalFunctionForRealtimeThread).

  • ERealtimeStateWarn - no action. However, if the kernel trace flag KREALTIME is enabled then tracing will be emitted as if the thread state was ERealtimeStateOn.

Enumerators

ERealtimeStateOff

Thread is not realtime

ERealtimeStateOn

Thread is realtime

ERealtimeStateWarn

Thread is realtime but doesn't want this enforced