e32const.h File Reference

#include <e32const.h>

KDefaultJustifyWidth

const TIntKDefaultJustifyWidth

The default width value used when appending and justifying data in a descriptor.

See also: TDes16::AppendJustify() TDes16::Justify() TDes8::AppendJustify() TDes8::Justify()

KMaxCheckedUid

const TIntKMaxCheckedUid

Defines the number of TUids that form a TUidType.

See also: TUid TUidType

KNumTraceMaskWords

const TIntKNumTraceMaskWords

Defines the number of 32-bit debug trace mask words.

KMaxUidName

const TIntKMaxUidName

Defines the maximum length for the text form of a UID name.

See also: TUidName TUid::Name()

KMaxModuleVersionName

const TIntKMaxModuleVersionName

Defines the maximum length of a module name.

KMaxName

const TIntKMaxName

Defines the maximum length of the name of a reference counted object.

See also: TName

KMaxKernelName

const TIntKMaxKernelName

Defines the maximum length of the name of a reference counted kernel-side object.

KMaxProcessName

const TIntKMaxProcessName

Defines the maximum size of a process name.

KMaxLibraryName

const TIntKMaxLibraryName

Defines the maximum size of a library name.

KMaxInfoName

const TIntKMaxInfoName

Defines the maximum length of a TInfoName object.

KMaxFullName

const TIntKMaxFullName

Defines the maximum length of the full name of a reference counted object.

See also: TFullName

KMaxPassword

const TIntKMaxPassword

The maximum length for a password buffer.

See also: TPassword

KMaxExitCategoryName

const TIntKMaxExitCategoryName

The maximum length of a category name.

See also: TExitCategoryName

KMaxDayName

const TIntKMaxDayName

The maximum length of the full text name for a day of the week.

See also: TDayName

KMaxDayNameAbb

const TIntKMaxDayNameAbb

The maximum length of the abbreviated text name for a day of the week.

See also: TDayNameAbb

KMaxDays

const TIntKMaxDays

Defines the maximum size of arrays or data structures required to hold the names of the days of the week.

KMaxMonthName

const TIntKMaxMonthName

The maximum length of the full text name for a month.

See also: TDayName

KMaxMonthNameAbb

const TIntKMaxMonthNameAbb

The maximum length of the abbreviated text name for a month.

See also: TMonthNameAbb

KMaxMonths

const TIntKMaxMonths

Defines the maximum size of arrays or data structures required to hold the names of the months of the year.

KMaxSuffix

const TIntKMaxSuffix

The maximum length of the text for a date suffix.

See also: TDateSuffix

KMaxSuffixes

const TIntKMaxSuffixes

Defines the maximum size of arrays and data structures required to hold date suffix strings.

KMaxAmPmName

const TIntKMaxAmPmName

The maximum length of the text for AM and PM.

See also: TAmPmName

KMaxAmPms

const TIntKMaxAmPms

Defines the maximum size of arrays and data structures required to hold am/pm strings.

KMaxDateSeparators

const TIntKMaxDateSeparators

Defines the maximum number of date separator characters in a date string.

KMaxTimeSeparators

const TIntKMaxTimeSeparators

Defines the maximum number of time separator characters in a time string.

KMaxTranslateTable

const TIntKMaxTranslateTable

Defines the maximum size of data structures to hold the translate tables for Western European alphabetic conversions.

KMaxCurrencySymbol

const TIntKMaxCurrencySymbol

The maximum length of the text for a currency symbol.

See also: TCurrencySymbol

KMaxShortDateFormatSpec

const TIntKMaxShortDateFormatSpec

The maximum length of the short date format specification text.

See also: TShortDateFormatSpec

KMaxLongDateFormatSpec

const TIntKMaxLongDateFormatSpec

The maximum length of the short date format specification text.

See also: TLongDateFormatSpec

KMaxTimeFormatSpec

const TIntKMaxTimeFormatSpec

The maximum length of the time string formatting commands.

See also: TTimeFormatSpec

KMaxFileName

const TIntKMaxFileName

Defines the maximum length of a filename.

KMaxVersionName

const TIntKMaxVersionName

The maximum length of the character representation of version information.

See also: TVersion::Name()

KMaxPath

const TIntKMaxPath

Defines the maximum length of a path.

See also: TPath

KMaxDeviceInfo

const TIntKMaxDeviceInfo

Defines the maximum length of a TDeviceInfo object.

See also: TDeviceInfo

KMaxMediaPassword

const TIntKMaxMediaPassword

The maximum size of the password required to unlock a media drive.

KMinHeapSize

const TIntKMinHeapSize

Defines the minimum size of a new heap.

Functions that require a new heap to be allocated will either panic, or will reset the required heap size to this value if a smaller heap size is specified.

See also: UserHeap RThread::Create()

KDstHome

const TIntKDstHome

Not used by Symbian OS.

KDstEuropean

const TIntKDstEuropean

Not used by Symbian OS.

KDstNorthern

const TIntKDstNorthern

Not used by Symbian OS.

KDstSouthern

const TIntKDstSouthern

Not used by Symbian OS.

KDefaultStackSize

const TIntKDefaultStackSize

A default stack size that can be used when creating threads.

KNoChar

const TUintKNoChar

Indicates an undefined character, used internally when formatting text.

KIndexPtr

const TIntKIndexPtr

Defines an index value that is interpreted by the TKey class, and derived classes, as having a specific meaning.

See also: TKey::SetPtr() TKey::At()

KHandleNoClose

const TIntKHandleNoClose

A flag used by the kernel to mark a handle as not being closable.

KHandleFlagLocal

const TIntKHandleFlagLocal

A flag used by the kernel to mark a handle as being local.

KCurrentProcessHandle

const TIntKCurrentProcessHandle

A flag used by the Kernel to indicate the current process.

KCurrentThreadHandle

const TIntKCurrentThreadHandle

A flag used by the Kernel to indicate the current thread.

KNullHandle

const TIntKNullHandle

Defines a handle number value of zero.

See also: RHandleBase

KDefaultUnit

const TIntKDefaultUnit

Defines a default unit. Not generally used by Symbian OS.

KNullUnit

const TIntKNullUnit

The device unit that must be passed in a call to RBusLogicalChannel::DoCreate(), if units are not permitted.

See also: RBusLogicalChannel

KMaxUnits

const TIntKMaxUnits

The maximum unit number that can be passed in a call to RBusLogicalChannel::DoCreate().

See also: RBusLogicalChannel

KMaxMessageArguments

const TIntKMaxMessageArguments

Defines the maximum number of message arguments that can be passed across the user side/kernel side boundary.

KDefaultRealWidth

const TIntKDefaultRealWidth

The default width of the character representation of a real number, used by the default constructor of a TRealFormat object and the formatting functions of descriptors.

See also: TRealFormat TDes16::AppendFormat() TDes8::AppendFormat()

KMinHeapGrowBy

const TIntKMinHeapGrowBy

The default value used by UserHeap::ChunkHeap() for defining increments to the size of a chunk, when no explicit value specified by the caller.

See also: UserHeap::ChunkHeap()

KMaxExponentConversion

const TIntKMaxExponentConversion

Not used by Symbian OS.

KNullUidValue

const TIntKNullUidValue

Defines a Null UID value.

See also: TUid

KDeltaTimerDefaultGranularity

const TIntKDeltaTimerDefaultGranularity

Deprecated

The timer granularity used by a CDeltaTimer object is now the tick period and this constant is obsolete.

See also: CDeltaTimer

KMaxTInt8

const TIntKMaxTInt8

The largest possible value for a TInt8.

KMinTInt8

const TIntKMinTInt8

The smallest possible value for a TInt8.

KMaxTUint8

const TUintKMaxTUint8

The largest possible value for a TUint8.

KMaxTInt16

const TIntKMaxTInt16

The largest possible value for a TInt16.

KMinTInt16

const TIntKMinTInt16

The smallest possible value for a TInt16.

KMaxTUint16

const TUintKMaxTUint16

The largest possible value for a TUint16.

KMaxTInt32

const TIntKMaxTInt32

The largest possible value for a TInt32.

KMinTInt32

const TIntKMinTInt32

The smallest possible value for a TInt32.

KMaxTUint32

const TUintKMaxTUint32

The largest possible value for a TUint32.

KMaxTInt

const TIntKMaxTInt

The largest possible value for a TInt.

KMinTInt

const TIntKMinTInt

The smallest possible value for a TInt.

KMaxTUint

const TUintKMaxTUint

The largest possible value for a TUint.

KMaxTInt64

const TInt64KMaxTInt64

The largest possible value for a TInt64.

KMinTInt64

const TInt64KMinTInt64

The smallest possible value for a TInt64.

KMaxTUint64

const TUint64KMaxTUint64

The largest possible value for a TUint64.

KMatchAny

const TUintKMatchAny

Defines the character *, and represents any number of characters in any part of a path component, filename or extension.

It is used in a TParse file specification.

See also: TParse

KMatchOne

const TUintKMatchOne

Defines the character ?, and represents a single character in a path component, filename or extension.

It is used in a TParse file specification.

See also: TParse

KMaxLocalDrives

const TIntKMaxLocalDrives

Defines the maximum number of local drives.

KMaxPBusSockets

const TIntKMaxPBusSockets

Defines the maximum number of peripheral bus sockets.

KNoCallEntryPoint

const TIntKNoCallEntryPoint

Not used by Symbian OS.

KRequestPending

const TIntKRequestPending

The value to which CActive::iStatus is set by an active object's service provider before the service provider initiates an asynchronous request.

See also: CActive

KDriveAttLocal

const TUintKDriveAttLocal

Drive attribute - drive is local.

KDriveAttRom

const TUintKDriveAttRom

Drive attribute - ROM drive.

KDriveAttRedirected

const TUintKDriveAttRedirected

Drive attribute - output from a process on one drive is redirected to another drive.

KDriveAttSubsted

const TUintKDriveAttSubsted

Drive attribute - drive letter has been substituted (assigned a path).

KDriveAttInternal

const TUintKDriveAttInternal

Drive attribute - drive is internal (not removable).

KDriveAttRemovable

const TUintKDriveAttRemovable

Drive attribute - drive is removable.

KDriveAttRemote

const TUintKDriveAttRemote

Drive attribute - drive is remote.

KDriveAttTransaction

const TUintKDriveAttTransaction

Drive attribute -.

KDriveAttPageable

const TUintKDriveAttPageable

Drive attribute - drive is used for paging.

KDriveAttLogicallyRemovable

const TUintKDriveAttLogicallyRemovable

Drive attribute - drive is logically removable (can be taken offline from Symbian OS). If not logically removable then physically removable e.g. a card can be take out.

KDriveAttHidden

const TUintKDriveAttHidden

Drive attribute - drive is hidden. A drive which has its hidden attribute set would be excluded from the list of available drives.

KDriveAttExternal

const TUintKDriveAttExternal

Drive attribute - drive is external.

KDriveAttAll

const TUintKDriveAttAll

Drive attribute - It can be set in a search in order to instruct that all drives should be returned.

KDriveAttExclude

const TUintKDriveAttExclude

Drive attribute - It can be set in combination with other drive attributes in order to exclude during a drive search, drives with these attributes set.

KDriveAttExclusive

const TUintKDriveAttExclusive

Drive attribute - It can be set in combination with other drive attributes in order to search and return exclusively drives with these attributes set.

KDriveAttMatchedFlags

const TUintKDriveAttMatchedFlags

Used as a mask in order to extract the actual drive attributes.

KDriveAttMatchedAtt

const TUintKDriveAttMatchedAtt

Used as a mask in order to extract the extra(ex KDriveAttAll ,KDriveAttExclude, KDriveAttExclusive ,0) drive attributes.

KMediaAttVariableSize

const TUintKMediaAttVariableSize

Media attribute - the media capacity can change over time.

KMediaAttDualDensity

const TUintKMediaAttDualDensity

Media attribute - media is dual density.

KMediaAttFormattable

const TUintKMediaAttFormattable

Media attribute - media is formattable.

KMediaAttWriteProtected

const TUintKMediaAttWriteProtected

Media attribute - media is write-protected.

KMediaAttLockable

const TUintKMediaAttLockable

Media attribute - media is lockable; this is provided for lockable multi-media cards

KMediaAttLocked

const TUintKMediaAttLocked

Media attribute - media is locked; this is provided for lockable multi-media cards

KMediaAttHasPassword

const TUintKMediaAttHasPassword

Media attribute - media has password.

KMediaAttReadWhileWrite

const TUintKMediaAttReadWhileWrite

KMediaAttDeleteNotify

const TUintKMediaAttDeleteNotify

Media attribute - media supports TBusLocalDrive::DeleteNotify()

KMediaAttPageable

const TUintKMediaAttPageable

Media attribute - media supports paging

KDriveFileSysFAT

const TUintKDriveFileSysFAT

Identifies a FAT file system

KDriveFileSysROM

const TUintKDriveFileSysROM

Identifies a ROM file system.

KDriveFileSysLFFS

const TUintKDriveFileSysLFFS

Identifies an LFFS file system.

KDriveFileSysROFS

const TUintKDriveFileSysROFS

Identifies a read-only file system.

KDriveFileNone

const TUintKDriveFileNone

Identifies a non-file system. That is a partition without any file system layer.

KDialectMask

const TUintKDialectMask

The mask for the dialect bits

KCreateProtectedObject

const TIntKCreateProtectedObject

KRealFormatTypesMask

const TIntKRealFormatTypesMask

A mask for the set of flags that govern the general format of the character representation of a real number.

These are the flags with symbols starting KRealFormat...

KRealFormatFixed

const TIntKRealFormatFixed

Defines the general format of the character representation of a real number. The TRealFormat::iType data member is set to one of these.

The real number is converted to fixed format which has the general pattern: "nnn.ddd", where nnn is the integer portion and ddd is the decimal portion. A negative value is prefixed by a minus sign.

The number of decimal places generated is defined by the value of TRealFormat::iPlaces. Trailing zeroes are generated as required. If necessary, the decimal portion is rounded to fit the specification. If this value is zero, no decimal point and no decimal portion is generated.

Triad separation is available, defined by TRealFormat::iTriad and TRealFormat::iTriLen.

Note that a zero value is converted either to the form "0.000..." with iPlaces '0' characters after the decimal point, if iPlaces is greater than zero, or to "0" if iPlaces is zero.

See also: TRealFormat

KRealFormatExponent

const TIntKRealFormatExponent

Defines the general format of the character representation of a real number. The TRealFormat::iType data member is set to one of these.

The real number is converted to scientific format with one non-zero digit before the decimal point and a number of digits after the decimal point. Hence the number has the general pattern: "n.dddE+ee" or "n.dddE-ee", or "n.dddE+eee" or "n.dddE-eee".

The decimal portion is followed by the character 'E', a sign ('+' or '-') and the exponent as two digits, including leading zeroes, if necessary. If necessary, the decimal portion is rounded.

A negative value is prefixed by a minus sign.

If the flag KUseSigFigs is not set, TRealFormat::iPlaces defines the number of digits which follow the decimal point. If the flag KUseSigFigs is set, iPlaces defines the maximum number of significant digits to be generated.

Note that, by default, exponents are limited to two digits. Those numbers that require three digits must have the flag KAllowThreeDigitExp set. If iPlaces is zero, the value is rounded to one digit of precision and no decimal point is included.

Triad separation is not available.

Note that a zero value is converted either to the form "0.000...E+00" with iPlaces '0' characters after the decimal point, if iPlaces is greater than zero, or to "0E+00" if iPlaces is zero.

See also: TRealFormat

KRealFormatGeneral

const TIntKRealFormatGeneral

Defines the general format of the character representation of a real number. The TRealFormat::iType data member is set to one of these.

The real number is converted either to fixed or scientific format. The format chosen is the one which can present the greater number of significant digits. Where both formats can present the same number of significant digits, fixed format is used.

The number of decimal places generated depends only on the value of TRealFormat::iWidth; the value of the iPlaces member is ignored.

Trailing zeroes in the decimal portion are discarded.

Triad separation is not available.

Note that a zero value is converted to "0".

See also: TRealFormat

KRealFormatNoExponent

const TIntKRealFormatNoExponent

Defines the general format of the character representation of a real number. The TRealFormat::iType data member is set to one of these.

The same as KRealFormatFixed but the TRealFormat::iPlaces is interpreted as specifying the maximum number of significant digits.

Trailing zeroes in the decimal portion are discarded.

See also: TRealFormat

KRealFormatCalculator

const TIntKRealFormatCalculator

Defines the general format of the character representation of a real number. The TRealFormat::iType data member is set to one of these.

The same as KRealFormatGeneral but TRealFormat::iPlaces is interpreted as specifying the maximum number of significant digits, and the number is displayed without an exponent whenever possible.

Trailing zeroes in the decimal portion are discarded.

See also: TRealFormat

KRealFormatTypeFlagsMask

const TIntKRealFormatTypeFlagsMask

A bitmask for all flags except those with symbols starting KRealFormat...

KExtraSpaceForSign

const TIntKExtraSpaceForSign

A flag that modifies the format of the character representation of a real number.

It reduces the effective width by one character. This forces a large enough value for TRealFormat::iWidth to be chosen to guarantee that positive and negative numbers can be shown to the same precision.

It applies when TRealFormat::iType is set to KRealFormatFixed or KRealFormatGeneral, and should be ORed into TRealFormat::iType after one of these types has been set.

KAllowThreeDigitExp

const TIntKAllowThreeDigitExp

A flag that modifies the format of the character representation of a real number.

It allows an exponent to be formatted whose magnitude is greater than 100. If this flag is not set, an attempt to format such a number fails.

If set, three digit exponents are allowed. If not set, only two digit exponents are allowed.

Applies when TRealFormat::iType is set to KRealFormatExponent or KRealFormatGeneral, and should be ORed into TRealFormat::iType after one of these types has been set.

KUseSigFigs

const TIntKUseSigFigs

A flag that modifies the format of the character representation of a real number.

If set, the TRealFormat::iPlaces member is interpreted as the maximum number of significant digits to be generated.

Applies when TRealFormat::iType is set to KRealFormatExponent, and should be ORed into TRealFormat::iType after this type has been set.

KDoNotUseTriads

const TIntKDoNotUseTriads

A flag that modifies the format of the character representation of a real number.

It disables triad separation.

Applies when TRealFormat::iType is set to KRealFormatFixed or KRealFormatNoExponent, and should be ORed into TRealFormat::iType after one of these types has been set.

KGeneralLimit

const TIntKGeneralLimit

A flag that modifies the format of the character representation of a real number.

If set, this flag limits the precision to KPrecisionLimit digits. If not set, the precision defaults to KMaxPrecision digits.

This flag should be ORed into TRealFormat::iType.

KRealInjectiveLimit

const TIntKRealInjectiveLimit

A flag that modifies the format of the character representation of a real number.

If set, this flag allows enough digits of precision such that the mapping from numeric to string form is injective. For a TReal (=double) input argument this means KIEEEDoubleInjectivePrecision digits. This flag overrides the KGeneralLimit flag if both are set.

This flag should be ORed into TRealFormat::iType.

Typedef TThreadFunction

typedef TInt(*TThreadFunction

Defines a pointer to a thread function which takes a pointer of type TAny and returns a TInt.

A function of this type is passed as parameter to RThread::Create() when creating a thread. Control passes to this function when the thread is first scheduled for execution.

See also: RThread

Typedef TLibraryFunction

typedef TInt(*TLibraryFunction

Defines a function that takes no arguments but returns a TInt.

This is a type which is returned from a call to RLibrary::Lookup().

See also: RLibrary

Typedef TLibraryEntry

typedef TInt(*TLibraryEntry

Defines a function that takes a single argument of type TInt and returns a TInt.

This is a type which is returned from a call to RLibrary::EntryPoint().

See also: RLibrary

Typedef TExceptionHandler

typedef void(*TExceptionHandler

Defines an exception handler function which takes a TExcType as an argument, and returns void.

A function of this type is an exception handler used by member functions of a thread handle, RThread.

See also: RThread TExcType

KExceptionAbort

const TUintKExceptionAbort

One of a set of flags that categorizes exceptions - associated with the abort exception only.

See also: RThread::SetExceptionHandler() RThread::ModifyExceptionMask()

KExceptionKill

const TUintKExceptionKill

One of a set of flags that categorizes exceptions - associated with the kill exception only.

See also: RThread::SetExceptionHandler() RThread::ModifyExceptionMask()

KExceptionUserInterrupt

const TUintKExceptionUserInterrupt

One of a set of flags that categorizes exceptions - general and user exceptions.

See also: RThread::SetExceptionHandler() RThread::ModifyExceptionMask()

KExceptionFpe

const TUintKExceptionFpe

One of a set of flags that categorizes exceptions - exceptions caused by illegal floating point operations. This exception is not guaranteed to be raised when a hardware floating point implementation is in use.

See also: RThread::SetExceptionHandler() RThread::ModifyExceptionMask()

KExceptionFault

const TUintKExceptionFault

One of a set of flags that categorizes exceptions - exceptions associated with executing instructions; includes protection faults, illegal instruction codes, page faults etc

See also: RThread::SetExceptionHandler() RThread::ModifyExceptionMask()

KExceptionInteger

const TUintKExceptionInteger

One of a set of flags that categorizes exceptions - exceptions caused by illegal operations on integer values.

KExceptionDebug

const TUintKExceptionDebug

One of a set of flags that categorizes exceptions - exceptions raised when debugging code.

See also: RThread::SetExceptionHandler() RThread::ModifyExceptionMask()

KBit0

const TUint32KBit0

Constant that defines the specified bit value.

KBit1

const TUint32KBit1

Constant that defines the specified bit value.

KBit2

const TUint32KBit2

Constant that defines the specified bit value.

KBit3

const TUint32KBit3

Constant that defines the specified bit value.

KBit4

const TUint32KBit4

Constant that defines the specified bit value.

KBit5

const TUint32KBit5

Constant that defines the specified bit value.

KBit6

const TUint32KBit6

Constant that defines the specified bit value.

KBit7

const TUint32KBit7

Constant that defines the specified bit value.

KBit8

const TUint32KBit8

Constant that defines the specified bit value.

KBit9

const TUint32KBit9

Constant that defines the specified bit value.

KBit10

const TUint32KBit10

Constant that defines the specified bit value.

KBit11

const TUint32KBit11

Constant that defines the specified bit value.

KBit12

const TUint32KBit12

Constant that defines the specified bit value.

KBit13

const TUint32KBit13

Constant that defines the specified bit value.

KBit14

const TUint32KBit14

Constant that defines the specified bit value.

KBit15

const TUint32KBit15

Constant that defines the specified bit value.

KBit16

const TUint32KBit16

Constant that defines the specified bit value.

KBit17

const TUint32KBit17

Constant that defines the specified bit value.

KBit18

const TUint32KBit18

Constant that defines the specified bit value.

KBit19

const TUint32KBit19

Constant that defines the specified bit value.

KBit20

const TUint32KBit20

Constant that defines the specified bit value.

KBit21

const TUint32KBit21

Constant that defines the specified bit value.

KBit22

const TUint32KBit22

Constant that defines the specified bit value.

KBit23

const TUint32KBit23

Constant that defines the specified bit value.

KBit24

const TUint32KBit24

Constant that defines the specified bit value.

KBit25

const TUint32KBit25

Constant that defines the specified bit value.

KBit26

const TUint32KBit26

Constant that defines the specified bit value.

KBit27

const TUint32KBit27

Constant that defines the specified bit value.

KBit28

const TUint32KBit28

Constant that defines the specified bit value.

KBit29

const TUint32KBit29

Constant that defines the specified bit value.

KBit30

const TUint32KBit30

Constant that defines the specified bit value.

KBit31

const TUint32KBit31

Constant that defines the specified bit value.

KSet32

const TUint32KSet32

Constant that defines the specified bit value.

This is often used as a bit mask.

KClear32

const TUint32KClear32

Constant that defines the specified bit value.

This is often used as a bit mask.

KKilo

const TIntKKilo

Constant that defines the specified value.

KMega

const TIntKMega

Constant that defines the specified value.

KNullDebugPort

const TIntKNullDebugPort

KNullThreadId

const TUintKNullThreadId

A constant which represents a thread ID which will never be assigned to a thread. I.e. The following statement is always true; RThread::Id()!=KNullThreadId

See also: TThreadId

KNullProcessId

const TUintKNullProcessId

A constant which represents a process ID which will never be assigned to a process. I.e. The following statement is always true; RProcess::Id()!=KNullProcessId

See also: TProcessId