#include <e32cmn.h>
#include <e32std.inl>
#include <e32std_private.h>

Classes
class	TFunctor

class	TCallBack
	Encapsulates a general call-back function. More...

class	TSglQueLink
	An object embedded within a class T so that objects of type T can form part of a singly linked list. More...

class	TDblQueLinkBase
	A base class that provides implementation for the link object of a doubly linked list. More...

class	TDblQueLink
	An object embedded within a class T so that objects of type T can form part of a doubly linked list. More...

class	TPriQueLink
	An object embedded within a class T so that objects of type T can form part of an ordered doubly linked list. More...

class	TDeltaQueLink
	An object embedded within a class T so that objects of type T can form part of a delta doubly linked list. More...

class	TTickCountQueLink
	An object embedded within a class T so that objects of type T can form part of a doubly linked list sorted by tick count. More...

class	TSglQueBase
	A base class that provides implementation for the singly linked list header. More...

class	TDblQueBase
	A base class that provides implementation for the doubly linked list header. More...

class	TDeltaQueBase
	A base class that provides implementation for the TDeltaQue template class. More...

class	TSglQue< T >
	A templated class that provides the behaviour for managing a singly linked list. More...

class	TDblQue< T >
	A templated class that provides the behaviour for managing a doubly linked list. More...

class	TPriQue< T >
	A templated class that provides the behaviour for managing a doubly linked list in which the elements are added in descending priority order. More...

class	TDeltaQue< T >
	A templated class that provides the behaviour for managing a doubly linked list in which elements represent values which are increments, or deltas, on the value represented by a preceding element. More...

class	TTickCountQue
	A class that provides the behaviour for managing a doubly linked list in which elements are added in order of the time until their tick count. More...

class	TSglQueIterBase
	A base class that provides implementation for the singly linked list iterator. More...

class	TSglQueIter< T >
	A templated class that provides the behaviour for iterating through a set of singly linked list elements. More...

class	TDblQueIterBase
	A base class that provides implementation for the doubly linked list iterator. More...

class	TDblQueIter< T >
	A templated class that provides the behaviour for iterating through a set of doubly linked list elements. More...

class	TKey
	Defines the characteristics of a key used to access the elements of an array. More...

class	TSwap
	Defines the basic behaviour for swapping two elements of an array. More...

class	TCharF
	Folds a specified character and provides functions to fold additional characters after construction of the object. More...

class	TCharLC
	Converts a specified character to lower case and provides functions to convert additional characters after construction of the object. More...

class	TCharUC
	Converts a specified character to upper case and provides functions to convert additional characters after construction of the object. More...

class	TRealFormat
	Defines the character representation of a real number type such as a TReal or a TRealX. More...

class	TLexMark8
	Defines the extraction mark used by the TLex8 class to indicate the current lexical element being analysed. More...

class	TLex8
	Provides general string-parsing functions suitable for numeric format conversions and syntactical-element parsing. More...

class	TLexMark16
	Defines the extraction mark used by the TLex16 class to indicate the current lexical element being analysed. More...

class	TLex16
	Provides general string-parsing functions suitable for numeric format conversions and syntactical-element parsing. More...

class	TCheckedUid
	Packages a Uid type together with a checksum. More...

class	TDateTime
	A date and time object in which the individual components are accessible in human-readable form. More...

class	TTimeIntervalMicroSeconds
	Represents a time interval of a millionth of a second stored as a 64-bit integer. More...

class	TTimeIntervalBase
	Provides a base class for all time interval classes using a 32-bit representation. More...

class	TTimeIntervalMicroSeconds32
	Represents a microsecond time interval stored in 32 rather than 64 bits. More...

class	TTimeIntervalSeconds
	Represents a time interval in seconds. More...

class	TTimeIntervalMinutes
	Represents a time interval in minutes. More...

class	TTimeIntervalHours
	Represents a time interval in hours. More...

class	TTimeIntervalDays
	Represents a time interval in days. More...

class	TTimeIntervalMonths
	Represents a time interval in months. More...

class	TTimeIntervalYears
	Represents a time interval in years. More...

class	TTime
	Stores and manipulates the date and time. More...

class	Time
	A utility class whose functions may be used by the other date/time related classes. More...

class	TDayName
	Gets a copy of the current locale's full text name for a day of the week. More...

class	TDayNameAbb
	Gets a copy of the current locale's abbreviated text name for a day of the week. More...

class	TMonthName
	Gets a copy of the current locale's full text name for a month. More...

class	TMonthNameAbb
	Gets a copy of the current locale's abbreviated text name for a month. More...

class	TDateSuffix
	Gets a copy of the current locale's date suffix text for a specific day in the month. More...

class	TAmPmName
	Current locale's am/pm text. More...

class	TCurrencySymbol
	Gets a copy of the currency symbol(s) in use by the current locale. More...

class	TShortDateFormatSpec
	Contains a format list that defines the short date format. More...

class	TLongDateFormatSpec
	Contains a format list that defines the long date format. More...

class	TTimeFormatSpec
	Contains a format list that defines the time string format. More...

class	TLocale
	Sets and gets the system's locale settings. More...

struct	SLocaleLanguage

struct	SLocaleLocaleSettings

struct	SLocaleTimeDateFormat

class	TExtendedLocale
	Extended locale class. More...

class	TRect
	Geometric rectangle. More...

class	TRegion
	Clipping region - abstract base class. More...

class	RRegion
	Expandable region. More...

class	RRegionBuf< S >
	Region with pre-allocated buffer. More...

class	TRegionFix< S >
	A fixed size region. More...

class	TFindHandleBase
	Base class for searching for global kernel objects. More...

class	TFindSemaphore
	Finds all global semaphores whose full names match a specified pattern. More...

class	TFindMutex
	Finds all global mutexes whose full names match a specified pattern. More...

class	TFindChunk
	Searches for all global chunks by pattern matching against the names of (Kernel side) chunk objects. More...

class	TFindThread
	Searches for threads by pattern matching against the names of thread objects. More...

class	TFindProcess
	Searches for processes by pattern matching against the names of process objects. More...

class	TFindLogicalDevice
	Searches for LDD factory objects by pattern matching against the names of LDD factory objects. More...

class	TFindPhysicalDevice
	Searches for PDD factory objects by pattern matching against the names of PDD factory objects. More...

class	TFindServer
	Searches for servers by pattern matching against the names of kernel side server objects. More...

class	TFindLibrary
	Searches for DLLs whose full names match a specified pattern. More...

class	RDevice
	User side handle to an LDD factory object, an instance of a DLogicalDevice derived class. More...

class	RTimer
	Asynchronous timer services. More...

class	RLibrary
	A handle to a dynamically loadable DLL. More...

struct	RLibrary::TInfo

struct	RLibrary::TInfoV2

struct	RLibrary::SInfo

class	RCriticalSection
	A handle to a critical section. More...

class	RMutex
	A handle to a mutex. More...

class	RCondVar
	A handle to a condition variable. More...

class	RChunk
	A handle to a chunk. More...

struct	TChunkCreateInfo
	This structure specifies the type and properties of the chunk to be created. More...

struct	TChunkHeapCreateInfo
	This structure specifies the type and properties of the user heap to be created. More...

class	UserHeap
	A set of static functions for constructing fixed length heaps and local or global heaps. More...

class	TObjectId
	Encapsulates the Id of a kernel object. More...

class	TThreadId
	Encapsulates the Id of a thread. More...

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

class	RThread
	A handle to a thread. More...

class	TProcessId
	Encapsulates the Id of a process. More...

class	RProcess
	A handle to a process. More...

class	RServer2

class	RSessionBase
	Client-side handle to a session with a server. More...

class	RSubSessionBase
	Client-side handle to a sub-session. More...

class	RRefBase
	Base class that provides an implementation for the templated RRef class. More...

class	RRef< T >
	Contains, or packages, a copy of an instance of another class. More...

class	RChangeNotifier
	A handle to a change notifier. More...

class	RUndertaker
	Handle to a thread death notifier. More...

class	RNotifier
	A handle to a session with the extended notifier server that provides support for plug-in notifiers. More...

class	TTrapHandler
	Abstract class that defines a handler to work with the TRAP mechanism. More...

class	Mem
	Contains a set of static functions which perform manipulation of data in memory. More...

class	User
	Set of static user functions. More...

class	Dll
	A collection of static functions involved in managing access to thread-local storage. More...

class	TFixedArray< T, S >
	A thin wrapper class for C++ arrays allowing automatic checking of index values to ensure that all accesses are legal. More...

Macros
#define	DECLARE_ROM_ARRAY(AName, AData, AType)

#define	__ASSERT_ALWAYS_NO_LEAVE(_s)
	Macro to assert in all builds that code does not leave.

#define	__ASSERT_DEBUG_NO_LEAVE(_s) { _s; }
	Macro to assert in debug builds that code does not leave.

Typedefs
typedef TLex8	TLex
	Provides access to general string-parsing functions suitable for numeric format conversions and syntactical-element parsing.

typedef TLexMark8	TLexMark
	Defines the extraction mark used by the TLex classes to indicate the current lexical element being analysed.

typedef void(*	TTlsCleanupHandler) (TAny *)

Enumerations
enum	TKeyCmpText { ECmpNormal , ECmpNormal8 , ECmpNormal16 , ECmpFolded , ECmpFolded8 , ECmpFolded16 , ECmpCollated , ECmpCollated8 , ECmpCollated16 }
	Governs the type of comparison to be made between descriptor keys or between text keys. More...

enum	TKeyCmpNumeric { ECmpTInt8 =((ECmpCollated16+1)<<1) , ECmpTInt16 , ECmpTInt32 , ECmpTInt , ECmpTUint8 , ECmpTUint16 , ECmpTUint32 , ECmpTUint , ECmpTInt64 }
	Governs the type of comparison to be made between numeric keys. More...

enum	{ EParseTimePresent =0x1 , EParseDatePresent =0x2 }
	An enumeration one or both of whose enumerator values may be returned by TTime::Parse(). More...

enum	TLocaleAspect { ELocaleLanguageSettings = 0x01 , ELocaleCollateSetting = 0x02 , ELocaleLocaleSettings = 0x04 , ELocaleTimeDateSettings = 0x08 }
	TLocaleAspect. More...

Functions
TAny *	operator new (TUint aSize, TLeave)

TAny *	operator new (TUint aSize, TLeave, TUint aExtraSize)

TAny *	operator new[] (TUint aSize, TLeave)

Macro Definition Documentation

◆ __ASSERT_ALWAYS_NO_LEAVE

#define __ASSERT_ALWAYS_NO_LEAVE ( _s )

Value:

    {                                   \
    TInt _r;                            \
    TTrap _t;                           \
    if (_t.Trap(_r) == 0)               \
        {                               \
        _s;                             \
        TTrap::UnTrap();                \
        }                               \
    else                                \
        User::PanicUnexpectedLeave();   \
    }

Macro to assert in all builds that code does not leave.

Parameters

_s	C++ statements to be executed which should not leave Panic condition: USER 194 if the code being checked does leave

API status: Published to all clients. Released API.

Definition at line 5629 of file e32std.h.

◆ __ASSERT_DEBUG_NO_LEAVE

#define __ASSERT_DEBUG_NO_LEAVE ( _s ) { _s; }

Macro to assert in debug builds that code does not leave.

Parameters

_s	C++ statements to be executed which should not leave Panic condition: USER 194 if the code being checked does leave

API status: Published to all clients. Released API.

Definition at line 5655 of file e32std.h.

◆ DECLARE_ROM_ARRAY

#define DECLARE_ROM_ARRAY	(	AName,
		AData,
		AType
	)

Value:

    const TFixedArray<AType,(sizeof(AData)/sizeof((AData)[0]))>& \
            AName = *(reinterpret_cast<const TFixedArray<AType, \
                           (sizeof(AData)/sizeof((AData)[0]))>* > (AData))

API status: Published to all clients. Released API.

Definition at line 5560 of file e32std.h.

Typedef Documentation

◆ TLex

typedef TLex8 TLex

Provides access to general string-parsing functions suitable for numeric format conversions and syntactical-element parsing.

It maps directly to either a TLex16 for a Unicode build or a TLex8 for a non-Unicode build.

The build independent type should always be used unless an explicit 16 bit or 8 bit build variant is required.

See also: TLex16; TLex8

API status: Published to all clients. Released API.

Definition at line 1480 of file e32std.h.

◆ TLexMark

typedef TLexMark8 TLexMark

Defines the extraction mark used by the TLex classes to indicate the current lexical element being analysed.

It maps directly to either a TLexMark16 for a Unicode build or a TLexMark8 for a non-Unicode build.

The build independent type should always be used unless an explicit 16 bit or 8 bit build variant is required.

API status: Published to all clients. Released API.

Definition at line 1500 of file e32std.h.

◆ TTlsCleanupHandler

typedef void(* TTlsCleanupHandler) (TAny *)

API status: Internal component API. Removed API.

Definition at line 5458 of file e32std.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

An enumeration one or both of whose enumerator values may be returned by TTime::Parse().

See also: TTime::Parse

API status: Published to all clients. Released API.

Enumerator

EParseTimePresent

Indicates that a time is present.

See also: TTime::Parse

EParseDatePresent

Indicates that a date is present.

See also: TTime::Parse

Definition at line 1833 of file e32std.h.

◆ TKeyCmpNumeric

enum TKeyCmpNumeric

Governs the type of comparison to be made between numeric keys.

See also: TKeyArrayFix; TKeyArrayVar; TKeyArrayPak

API status: Published to all clients. Released API.

Enumerator
ECmpTInt8	The key is assumed to be of type TInt8.
ECmpTInt16	The key is assumed to be of type TInt16.
ECmpTInt32	The key is assumed to be of type TInt32.
ECmpTInt	The key is assumed to be of type TInt.
ECmpTUint8	The key is assumed to be of type TUint8.
ECmpTUint16	The key is assumed to be of type TUint16.
ECmpTUint32	The key is assumed to be of type TUint32.
ECmpTUint	The key is assumed to be of type TUint.
ECmpTInt64	The key is assumed to be of type TInt64.

Definition at line 833 of file e32std.h.

◆ TKeyCmpText

enum TKeyCmpText

Governs the type of comparison to be made between descriptor keys or between text keys.

See also: TKeyArrayFix; TKeyArrayVar; TKeyArrayPak

API status: Published to all clients. Released API.

Enumerator
ECmpNormal	For a Unicode build, this is the same as ECmpNormal16. For a non-Unicode build, this is the same as ECmpNormal8. Using the build independent names (i.e. TPtrC, TPtr, TBufC, TBuf or TText) allows the compiler to chose the correct variant according to the build.
ECmpNormal8	For descriptor keys, the key is assumed to be the 8 bit variant, derived from TDesc8. A simple comparison is done between the content of the descriptors; the data is not folded and collation rules are not applied for the purpose of the comparison. For text keys, the key is assumed to be the 8 bit variant, of type TText8. A normal comparison is done between the text data; the data is not folded and collation rules are not applied for the purpose of the comparison.
ECmpNormal16	For descriptor keys, the key is assumed to be the 16 bit variant, derived from TDesc16. A simple comparison is done between the content of the descriptors; the data is not folded and collation rules are not applied for the purpose of the comparison. For text keys, the key is assumed to be the 16 bit variant, of type TText16. A normal comparison is done between the text data; the data is not folded and collation rules are not applied for the purpose of the comparison.
ECmpFolded	For a Unicode build, this is the same as EcmpFolded16. For a non-Unicode build, this is the same as EcmpFolded8. Using the build independent names (i.e. TPtrC, TPtr, TBufC, TBuf or TText) allows the compiler to chose the correct variant according to the build.
ECmpFolded8	For descriptor keys, the key is assumed to be the 8 bit variant, derived from TDesc8. The descriptor contents are folded for the purpose of the comparison. For text keys, the key is assumed to be the 8 bit variant, of type TText8. The text data is folded for the purpose of the comparison.
ECmpFolded16	For descriptor keys, the key is assumed to be the 16 bit variant, derived from TDesc16. The descriptor contents are folded for the purpose of the comparison. For text keys, the key is assumed to be the 16 bit variant, of type TText16. The text data is folded for the purpose of the comparison.
ECmpCollated	For a Unicode build, this is the same as EcmpCollated16. For a non-Unicode build, this is the same as EcmpCollated8. Using the build independent names (i.e. TPtrC, TPtr, TBufC, TBuf or TText) allows the compiler to chose the correct variant according to the build.
ECmpCollated8	For descriptor keys, the key is assumed to be the 8 bit variant, derived from TDesc8. Collation rules are applied for the purpose of the comparison. For text keys, the key is assumed to be the 8 bit variant, of type TText8. Collation rules are applied for the purpose of the comparison.
ECmpCollated16	For descriptor keys, the key is assumed to be the 16 bit variant, derived from TDesc16. Collation rules are applied for the purpose of the comparison. For text keys, the key is assumed to be the 16 bit variant, of type TText16. Collation rules are applied for the purpose of the comparison.

Definition at line 714 of file e32std.h.

◆ TLocaleAspect

enum TLocaleAspect

TLocaleAspect.

Enumeration used with TExtendedLocale::LoadLocaleAspect to select which locale information is to be replaced from the contents of the Locale DLL being loaded.

ELocaleLanguageSettings - Replaces everything that should change with language selection e.g. Month names, Day names, etc,

ELocaleLocaleSettings - Replaces the currently selected currency symbol, TLocale settings, and FAT utility functions

ELocaleTimeAndDateSettings - Replaces the current time and date display format settings.

ELocaleCollateSettings - Replaces the "system" preferred Charset (because that's where the collation table is!). The "Default" charset will remain unchanged until after the next power off/on cycle

API status: Published to all clients. Released API.

Enumerator
ELocaleLanguageSettings
ELocaleCollateSetting
ELocaleLocaleSettings
ELocaleTimeDateSettings

Definition at line 2494 of file e32std.h.

Function Documentation

◆ operator new() [1/2]

TAny * operator new	(	TUint	aSize,
		TLeave
	)

inline

API status: Published to all clients. Released API.

◆ operator new() [2/2]

TAny * operator new	(	TUint	aSize,
		TLeave	,
		TUint	aExtraSize
	)

inline

API status: Published to all clients. Released API.

◆ operator new[]()

TAny * operator new[]	(	TUint	aSize,
		TLeave
	)

inline

API status: Published to all clients. Released API.

Classes

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ __ASSERT_ALWAYS_NO_LEAVE

◆ __ASSERT_DEBUG_NO_LEAVE

◆ DECLARE_ROM_ARRAY

Typedef Documentation

◆ TLex

◆ TLexMark

◆ TTlsCleanupHandler

Enumeration Type Documentation

◆ anonymous enum

◆ TKeyCmpNumeric

◆ TKeyCmpText

◆ TLocaleAspect

Function Documentation

◆ operator new() [1/2]

◆ operator new() [2/2]

◆ operator new[]()