sl@0: // Copyright (c) 1994-2009 Nokia Corporation and/or its subsidiary(-ies). sl@0: // All rights reserved. sl@0: // This component and the accompanying materials are made available sl@0: // under the terms of the License "Eclipse Public License v1.0" sl@0: // which accompanies this distribution, and is available sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html". sl@0: // sl@0: // Initial Contributors: sl@0: // Nokia Corporation - initial contribution. sl@0: // sl@0: // Contributors: sl@0: // sl@0: // Description: sl@0: // e32\include\e32const.h sl@0: // sl@0: // sl@0: sl@0: #ifndef __E32CONST_H__ sl@0: #define __E32CONST_H__ sl@0: sl@0: #include sl@0: #include sl@0: #include sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The default width value used when appending and justifying data sl@0: in a descriptor. sl@0: sl@0: @see TDes16::AppendJustify() sl@0: @see TDes16::Justify() sl@0: @see TDes8::AppendJustify() sl@0: @see TDes8::Justify() sl@0: */ sl@0: const TInt KDefaultJustifyWidth=(-1); sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the number of TUids that form a TUidType. sl@0: sl@0: @see TUid sl@0: @see TUidType sl@0: */ sl@0: const TInt KMaxCheckedUid=3; sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the number of 32-bit debug trace mask words. sl@0: sl@0: */ sl@0: const TInt KNumTraceMaskWords = 8; sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum length for the text form of a UID name. sl@0: sl@0: @see TUidName sl@0: @see TUid::Name() sl@0: */ sl@0: const TInt KMaxUidName=10; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum length of a module name. sl@0: */ sl@0: const TInt KMaxModuleVersionName=10; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum length of the name of a reference counted object. sl@0: sl@0: @see TName sl@0: */ sl@0: const TInt KMaxName=0x80; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum length of the name of a reference counted kernel-side object. sl@0: */ sl@0: const TInt KMaxKernelName=0x50; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum size of a process name. sl@0: */ sl@0: const TInt KMaxProcessName=(KMaxKernelName-KMaxUidName-KMaxModuleVersionName-4); sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum size of a library name. sl@0: */ sl@0: const TInt KMaxLibraryName=(KMaxKernelName-KMaxUidName-KMaxModuleVersionName); sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum length of a TInfoName object. sl@0: */ sl@0: const TInt KMaxInfoName=0x10; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum length of the full name of a reference counted object. sl@0: sl@0: @see TFullName sl@0: */ sl@0: const TInt KMaxFullName=(KMaxName<<1); sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length for a password buffer. sl@0: sl@0: @see TPassword sl@0: */ sl@0: const TInt KMaxPassword=0x10; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of a category name. sl@0: sl@0: @see TExitCategoryName sl@0: */ sl@0: const TInt KMaxExitCategoryName=0x10; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of the full text name for a day of the week. sl@0: sl@0: @see TDayName sl@0: */ sl@0: const TInt KMaxDayName=0x20; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of the abbreviated text name for a day of the week. sl@0: sl@0: @see TDayNameAbb sl@0: */ sl@0: const TInt KMaxDayNameAbb=0x08; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum size of arrays or data structures required sl@0: to hold the names of the days of the week. sl@0: */ sl@0: const TInt KMaxDays=7; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of the full text name for a month. sl@0: sl@0: @see TDayName sl@0: */ sl@0: const TInt KMaxMonthName=0x20; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of the abbreviated text name for a month. sl@0: sl@0: @see TMonthNameAbb sl@0: */ sl@0: const TInt KMaxMonthNameAbb=0x08; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum size of arrays or data structures required sl@0: to hold the names of the months of the year. sl@0: */ sl@0: const TInt KMaxMonths=12; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of the text for a date suffix. sl@0: sl@0: @see TDateSuffix sl@0: */ sl@0: const TInt KMaxSuffix=0x04; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum size of arrays and data structures required sl@0: to hold date suffix strings. sl@0: */ sl@0: const TInt KMaxSuffixes=31; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of the text for AM and PM. sl@0: sl@0: @see TAmPmName sl@0: */ sl@0: const TInt KMaxAmPmName=0x04; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum size of arrays and data structures required sl@0: to hold am/pm strings. sl@0: */ sl@0: const TInt KMaxAmPms=2; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum number of date separator characters in a date string. sl@0: */ sl@0: const TInt KMaxDateSeparators=4; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum number of time separator characters in a time string. sl@0: */ sl@0: const TInt KMaxTimeSeparators=4; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum size of data structures to hold the translate tables sl@0: for Western European alphabetic conversions. sl@0: */ sl@0: const TInt KMaxTranslateTable=0x100; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of the text for a currency symbol. sl@0: sl@0: @see TCurrencySymbol sl@0: */ sl@0: const TInt KMaxCurrencySymbol=0x08; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of the short date format specification text. sl@0: sl@0: @see TShortDateFormatSpec sl@0: */ sl@0: const TInt KMaxShortDateFormatSpec=40; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of the short date format specification text. sl@0: sl@0: @see TLongDateFormatSpec sl@0: */ sl@0: const TInt KMaxLongDateFormatSpec=80; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of the time string formatting commands. sl@0: sl@0: @see TTimeFormatSpec sl@0: */ sl@0: const TInt KMaxTimeFormatSpec=60; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum length of a filename. sl@0: */ sl@0: const TInt KMaxFileName=0x100; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum length of the character representation of version information. sl@0: sl@0: @see TVersion::Name() sl@0: */ sl@0: const TInt KMaxVersionName=0x10; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum length of a path. sl@0: sl@0: @see TPath sl@0: */ sl@0: const TInt KMaxPath=0x100; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum length of a TDeviceInfo object. sl@0: sl@0: @see TDeviceInfo sl@0: */ sl@0: const TInt KMaxDeviceInfo=0x80; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum size of the password required to unlock a media drive. sl@0: */ sl@0: const TInt KMaxMediaPassword=16; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the minimum size of a new heap. sl@0: sl@0: Functions that require a new heap to be allocated will either panic, sl@0: or will reset the required heap size to this value if a smaller heap sl@0: size is specified. sl@0: sl@0: @see UserHeap sl@0: @see RThread::Create() sl@0: */ sl@0: const TInt KMinHeapSize=0x100; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Not used by Symbian OS. sl@0: */ sl@0: const TInt KDstHome=0x01; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Not used by Symbian OS. sl@0: */ sl@0: const TInt KDstEuropean=0x02; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Not used by Symbian OS. sl@0: */ sl@0: const TInt KDstNorthern=0x04; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Not used by Symbian OS. sl@0: */ sl@0: const TInt KDstSouthern=0x08; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: A default stack size that can be used when creating threads. sl@0: */ sl@0: #ifdef __X86GCC__ sl@0: const TInt KDefaultStackSize=0x4000; sl@0: #else sl@0: const TInt KDefaultStackSize=0x2000; sl@0: #endif // __X86GCC__ sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Indicates an undefined character, used internally when formatting text. sl@0: */ sl@0: const TUint KNoChar=0xffffffffu; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines an index value that is interpreted by the TKey class, sl@0: and derived classes, as having a specific meaning. sl@0: sl@0: @see TKey::SetPtr() sl@0: @see TKey::At() sl@0: */ sl@0: const TInt KIndexPtr=(-1); sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: A flag used by the kernel to mark a handle as not being closable. sl@0: */ sl@0: const TInt KHandleNoClose=0x00008000; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: A flag used by the kernel to mark a handle as being local. sl@0: */ sl@0: const TInt KHandleFlagLocal=0x40000000; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: A flag used by the Kernel to indicate the current process. sl@0: */ sl@0: const TInt KCurrentProcessHandle=0xffff0000|KHandleNoClose; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: A flag used by the Kernel to indicate the current thread. sl@0: */ sl@0: const TInt KCurrentThreadHandle=0xffff0001|KHandleNoClose; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines a handle number value of zero. sl@0: sl@0: @see RHandleBase sl@0: */ sl@0: const TInt KNullHandle=0; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines a default unit. Not generally used by Symbian OS. sl@0: */ sl@0: const TInt KDefaultUnit=0x00; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The device unit that must be passed in a call sl@0: to RBusLogicalChannel::DoCreate(), if units are not permitted. sl@0: sl@0: @see RBusLogicalChannel sl@0: */ sl@0: const TInt KNullUnit=0xffffffff; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The maximum unit number that can be passed in a call sl@0: to RBusLogicalChannel::DoCreate(). sl@0: sl@0: @see RBusLogicalChannel sl@0: */ sl@0: const TInt KMaxUnits=0x20; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum number of message arguments that can be passed sl@0: across the user side/kernel side boundary. sl@0: */ sl@0: const TInt KMaxMessageArguments=0x04; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The default width of the character representation of a real number, used by sl@0: the default constructor of a TRealFormat object and the formatting functions sl@0: of descriptors. sl@0: sl@0: @see TRealFormat sl@0: @see TDes16::AppendFormat() sl@0: @see TDes8::AppendFormat() sl@0: */ sl@0: const TInt KDefaultRealWidth=20; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The default value used by UserHeap::ChunkHeap() for defining increments to sl@0: the size of a chunk, when no explicit value specified by the caller. sl@0: sl@0: @see UserHeap::ChunkHeap() sl@0: */ sl@0: const TInt KMinHeapGrowBy=0x1000; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Not used by Symbian OS. sl@0: */ sl@0: const TInt KMaxExponentConversion=99; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines a Null UID value. sl@0: sl@0: @see TUid sl@0: */ sl@0: const TInt KNullUidValue=0; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @deprecated sl@0: sl@0: The timer granularity used by a CDeltaTimer object is sl@0: now the tick period and this constant is obsolete. sl@0: sl@0: @see CDeltaTimer sl@0: */ sl@0: const TInt KDeltaTimerDefaultGranularity=100000; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The largest possible value for a TInt8. sl@0: */ sl@0: const TInt KMaxTInt8=0x7f; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The smallest possible value for a TInt8. sl@0: */ sl@0: const TInt KMinTInt8=(-128); sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The largest possible value for a TUint8. sl@0: */ sl@0: const TUint KMaxTUint8=0xffu; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The largest possible value for a TInt16. sl@0: */ sl@0: const TInt KMaxTInt16=0x7fff; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The smallest possible value for a TInt16. sl@0: */ sl@0: const TInt KMinTInt16=(-32768); sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The largest possible value for a TUint16. sl@0: */ sl@0: const TUint KMaxTUint16=0xffffu; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The largest possible value for a TInt32. sl@0: */ sl@0: const TInt KMaxTInt32=0x7fffffff; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The smallest possible value for a TInt32. sl@0: */ sl@0: const TInt KMinTInt32=(TInt)0x80000000; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The largest possible value for a TUint32. sl@0: */ sl@0: const TUint KMaxTUint32=0xffffffffu; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The largest possible value for a TInt. sl@0: */ sl@0: const TInt KMaxTInt=0x7fffffff; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The smallest possible value for a TInt. sl@0: */ sl@0: const TInt KMinTInt=(TInt)0x80000000; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The largest possible value for a TUint. sl@0: */ sl@0: const TUint KMaxTUint=0xffffffffu; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The largest possible value for a TInt64. sl@0: */ sl@0: const TInt64 KMaxTInt64 = I64LIT(0x7fffffffffffffff); sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The smallest possible value for a TInt64. sl@0: */ sl@0: const TInt64 KMinTInt64 = UI64LIT(0x8000000000000000); sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The largest possible value for a TUint64. sl@0: */ sl@0: const TUint64 KMaxTUint64 = UI64LIT(0xffffffffffffffff); sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the character *, and represents any number of characters in any sl@0: part of a path component, filename or extension. sl@0: sl@0: It is used in a TParse file specification. sl@0: sl@0: @see TParse sl@0: */ sl@0: const TUint KMatchAny='*'; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the character ?, and represents a single character in sl@0: a path component, filename or extension. sl@0: sl@0: It is used in a TParse file specification. sl@0: sl@0: @see TParse sl@0: */ sl@0: const TUint KMatchOne='?'; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum number of local drives. sl@0: */ sl@0: const TInt KMaxLocalDrives=16; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the maximum number of peripheral bus sockets. sl@0: */ sl@0: const TInt KMaxPBusSockets=4; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Not used by Symbian OS. sl@0: */ sl@0: const TInt KNoCallEntryPoint = 0x01; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The value to which CActive::iStatus is set by an active object's sl@0: service provider before the service provider initiates an asynchronous request. sl@0: sl@0: @see CActive sl@0: */ sl@0: const TInt KRequestPending=(-KMaxTInt); sl@0: sl@0: sl@0: sl@0: sl@0: // Drive capabilities sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the possible media types. sl@0: */ sl@0: enum TMediaType sl@0: { sl@0: EMediaNotPresent, sl@0: sl@0: EMediaUnknown, sl@0: sl@0: EMediaFloppy, sl@0: sl@0: /** Solid-state media. */ sl@0: EMediaHardDisk, sl@0: sl@0: EMediaCdRom, sl@0: sl@0: EMediaRam, sl@0: sl@0: EMediaFlash, sl@0: sl@0: EMediaRom, sl@0: sl@0: EMediaRemote, sl@0: sl@0: EMediaNANDFlash, sl@0: sl@0: /** Rotating media. */ sl@0: EMediaRotatingMedia sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the state of a battery, if supported. sl@0: */ sl@0: enum TBatteryState {EBatNotSupported,EBatGood,EBatLow}; sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the possible connection types used to interface to the media. sl@0: */ sl@0: enum TConnectionBusType {EConnectionBusInternal, EConnectionBusUsb}; sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - drive is local. sl@0: */ sl@0: const TUint KDriveAttLocal=0x01; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - ROM drive. sl@0: */ sl@0: const TUint KDriveAttRom=0x02; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - output from a process on one drive is redirected sl@0: to another drive. sl@0: */ sl@0: const TUint KDriveAttRedirected=0x04; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - drive letter has been substituted (assigned a path). sl@0: */ sl@0: const TUint KDriveAttSubsted=0x08; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - drive is internal (not removable). sl@0: */ sl@0: const TUint KDriveAttInternal=0x10; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - drive is removable. sl@0: */ sl@0: const TUint KDriveAttRemovable=0x20; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - drive is remote. sl@0: */ sl@0: const TUint KDriveAttRemote=0x40; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute -. sl@0: */ sl@0: const TUint KDriveAttTransaction=0x80; sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - drive is used for paging. sl@0: */ sl@0: const TUint KDriveAttPageable=0x100; sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - drive is logically removable (can be taken offline from Symbian OS). sl@0: If not logically removable then physically removable e.g. a card can be take out. sl@0: */ sl@0: const TUint KDriveAttLogicallyRemovable=0x200; sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - drive is hidden. sl@0: A drive which has its hidden attribute set would be excluded from the list of available drives. sl@0: */ sl@0: const TUint KDriveAttHidden=0x400; sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - drive is external. sl@0: */ sl@0: const TUint KDriveAttExternal=0x800; sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - It can be set in a search in order to instruct that all drives should be returned. sl@0: */ sl@0: const TUint KDriveAttAll=0x100000; sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - It can be set in combination with other drive attributes in order to exclude during a drive search, drives with sl@0: these attributes set. sl@0: */ sl@0: const TUint KDriveAttExclude=0x40000; sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Drive attribute - It can be set in combination with other drive attributes in order to search and return exclusively drives with these attributes set. sl@0: */ sl@0: const TUint KDriveAttExclusive=0x80000; sl@0: sl@0: sl@0: sl@0: /** sl@0: @internalTechnology sl@0: sl@0: Used as a mask in order to extract the actual drive attributes. sl@0: sl@0: */ sl@0: const TUint KDriveAttMatchedFlags=0xFFF; sl@0: sl@0: sl@0: sl@0: /** sl@0: @internalTechnology sl@0: sl@0: Used as a mask in order to extract the extra(ex KDriveAttAll ,KDriveAttExclude, KDriveAttExclusive ,0) drive attributes. sl@0: */ sl@0: const TUint KDriveAttMatchedAtt=0x0FFF0000; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Media attribute - the media capacity can change over time. sl@0: */ sl@0: const TUint KMediaAttVariableSize=0x01; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Media attribute - media is dual density. sl@0: */ sl@0: const TUint KMediaAttDualDensity=0x02; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Media attribute - media is formattable. sl@0: */ sl@0: const TUint KMediaAttFormattable=0x04; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Media attribute - media is write-protected. sl@0: */ sl@0: const TUint KMediaAttWriteProtected=0x08; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Media attribute - media is lockable; this is provided for sl@0: lockable multi-media cards sl@0: */ sl@0: const TUint KMediaAttLockable=0x10; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Media attribute - media is locked; this is provided for sl@0: lockable multi-media cards sl@0: */ sl@0: const TUint KMediaAttLocked=0x20; sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Media attribute - media has password. sl@0: */ sl@0: const TUint KMediaAttHasPassword=0x40; sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: const TUint KMediaAttReadWhileWrite=0x80; sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Media attribute - media supports TBusLocalDrive::DeleteNotify() sl@0: */ sl@0: const TUint KMediaAttDeleteNotify=0x100; sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Media attribute - media supports paging sl@0: */ sl@0: const TUint KMediaAttPageable=0x200; sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Identifies a FAT file system sl@0: */ sl@0: const TUint KDriveFileSysFAT=0x01; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Identifies a ROM file system. sl@0: */ sl@0: const TUint KDriveFileSysROM=0x02; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Identifies an LFFS file system. sl@0: */ sl@0: const TUint KDriveFileSysLFFS=0x03; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Identifies a read-only file system. sl@0: */ sl@0: const TUint KDriveFileSysROFS=0x04; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Identifies a non-file system. That is a partition without any file system layer. sl@0: */ sl@0: const TUint KDriveFileNone=0x05; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: An enumerator with a single enumeration value that defines the Boolean value sl@0: false in Symbian OS. sl@0: sl@0: @see TBool sl@0: */ sl@0: enum TFalse { sl@0: /** sl@0: Defines the value false that is passed to a TBool type. sl@0: */ sl@0: EFalse=FALSE sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: An enumerator with a single enumeration value that defines the Boolean value sl@0: true in Symbian OS. sl@0: sl@0: @see TBool sl@0: */ sl@0: enum TTrue { sl@0: /** sl@0: Defines the value true that is passed to a TBool type. sl@0: */ sl@0: ETrue=TRUE sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines flags that can be used to indicate whether duplicates, for example in sl@0: a list, are allowed. sl@0: */ sl@0: enum TAllowDuplicates { sl@0: /** sl@0: No duplicates allowed. sl@0: */ sl@0: ENoDuplicates, sl@0: sl@0: /** sl@0: Duplicates allowed. sl@0: */ sl@0: EAllowDuplicates sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: An enumeration whose enumerators determine the number system to be used sl@0: when converting numbers into a character format. sl@0: sl@0: @see TDes8::Num() sl@0: @see TDes8::NumUC() sl@0: @see TDes8::AppendNum() sl@0: @see TDes8::AppendNumUC() sl@0: @see TDes16::Num() sl@0: @see TDes16::NumUC() sl@0: @see TDes16::AppendNum() sl@0: @see TDes16::AppendNumUC() sl@0: */ sl@0: enum TRadix { sl@0: /** sl@0: Convert number into binary character representation. sl@0: */ sl@0: EBinary=2, sl@0: /** sl@0: Convert number into octal character representation. sl@0: */ sl@0: EOctal=8, sl@0: /** sl@0: Convert number into decimal character representation. sl@0: */ sl@0: EDecimal=10, sl@0: /** sl@0: Convert number into hexadecimal character representation. sl@0: */ sl@0: EHex=16 sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: The mask for the dialect bits sl@0: */ sl@0: const TUint KDialectMask=0x03FF; sl@0: sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the date formats. sl@0: */ sl@0: enum TDateFormat { sl@0: /** sl@0: US format (mm/dd/yyyy) sl@0: */ sl@0: EDateAmerican, sl@0: sl@0: /** sl@0: European format (dd/mm/yyyy) sl@0: */ sl@0: EDateEuropean, sl@0: sl@0: /** sl@0: Japanese format (yyyy/mm/dd) sl@0: */ sl@0: EDateJapanese}; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the time formats as either 12 hour or 24 hour. sl@0: */ sl@0: enum TTimeFormat { sl@0: ETime12, sl@0: ETime24 sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the clock display formats, as either analog or digital. sl@0: */ sl@0: enum TClockFormat { sl@0: EClockAnalog, sl@0: EClockDigital sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Enumerates the units of measurement as either Imperial or Metric. sl@0: */ sl@0: enum TUnitsFormat { sl@0: EUnitsImperial, sl@0: EUnitsMetric sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Identifies a time as being am or pm. sl@0: */ sl@0: enum TAmPm { sl@0: EAm, sl@0: EPm sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines whether: sl@0: sl@0: 1. the currency symbol is located before or after the currency amount. sl@0: sl@0: 2. the am/pm text is located before or after the time. sl@0: */ sl@0: enum TLocalePos sl@0: { sl@0: /** sl@0: The currency symbol is located before the currency amount. sl@0: The am/pm text is located before the time. sl@0: */ sl@0: ELocaleBefore, sl@0: sl@0: /** sl@0: The currency symbol is located after the currency amount. sl@0: The am/pm text is located after the time. sl@0: */ sl@0: ELocaleAfter sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Number Modes available to select. sl@0: */ sl@0: enum TDigitType sl@0: { sl@0: EDigitTypeUnknown = 0x0000, sl@0: EDigitTypeWestern = 0x0030, sl@0: EDigitTypeArabicIndic = 0x0660, sl@0: EDigitTypeEasternArabicIndic = 0x6F0, sl@0: EDigitTypeDevanagari = 0x0966, sl@0: EDigitTypeBengali = 0x09E6, sl@0: EDigitTypeGurmukhi = 0x0A66, sl@0: EDigitTypeGujarati = 0x0AE6, sl@0: EDigitTypeOriya = 0x0B66, sl@0: EDigitTypeTamil = 0x0BE6, sl@0: EDigitTypeTelugu = 0x0C66, sl@0: EDigitTypeKannada = 0x0CE6, sl@0: EDigitTypeMalayalam = 0x0D66, sl@0: EDigitTypeThai = 0x0E50, sl@0: EDigitTypeLao = 0x0ED0, sl@0: EDigitTypeTibetan = 0x0F20, sl@0: EDigitTypeMayanmar = 0x1040, sl@0: EDigitTypeKhmer = 0x17E0, sl@0: EDigitTypeAllTypes = 0xFFFF sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the daylight saving zones. sl@0: */ sl@0: enum TDaylightSavingZone sl@0: { sl@0: /** sl@0: The home daylight saving zone. Its value is usually the same as that of the sl@0: zone in which the home city is located, but may differ. In this case, the sl@0: value for home overrides the value of the zone in which home is located. sl@0: */ sl@0: EDstHome=0x40000000, sl@0: sl@0: /** sl@0: No daylight saving zone. sl@0: */ sl@0: EDstNone=0, sl@0: sl@0: /** sl@0: The European daylight saving zone. sl@0: */ sl@0: EDstEuropean=1, sl@0: sl@0: /** sl@0: The Northern hemisphere (non-European) daylight saving zone. sl@0: */ sl@0: EDstNorthern=2, sl@0: sl@0: /** sl@0: Southern hemisphere daylight saving zone. sl@0: */ sl@0: EDstSouthern=4 sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @internalComponent sl@0: sl@0: Indicates how negative currency values are formatted. sl@0: */ sl@0: enum TNegativeCurrencyFormat // must match TLocale:: version, included here so ELOCL.DLL can see it sl@0: { sl@0: E_NegC_LeadingMinusSign, sl@0: E_NegC_InBrackets,// this one must be non-zero for binary compatibility with the old TBool TLocale::iCurrencyNegativeInBrackets which was exposed in the binary interface because it was accessed via *inline* functions sl@0: E_NegC_InterveningMinusSignWithSpaces, sl@0: E_NegC_InterveningMinusSignWithoutSpaces, sl@0: E_NegC_TrailingMinusSign sl@0: }; sl@0: sl@0: /** sl@0: @internalComponent sl@0: sl@0: sl@0: Indicates how the device universal time is maintained sl@0: */ sl@0: enum TDeviceTimeState // must match TLocale:: version sl@0: { sl@0: /** Universal time is maintained by the device RTC and the user selection sl@0: of the locale of the device indicating offset from GMT and daylight saving*/ sl@0: EDeviceUserTime, sl@0: sl@0: /** Universal time and offset from GMT is supplied by the mobile network sl@0: and maintained by device RTC */ sl@0: ENITZNetworkTimeSync sl@0: }; sl@0: sl@0: /** sl@0: @internalComponent sl@0: sl@0: Indicates the type of conversion required for FAT filenames sl@0: */ sl@0: enum TFatFilenameConversionType sl@0: { sl@0: /** Undefined conversion scheme; conversion obtained is whatever the sl@0: default policy is for this version of the OS. */ sl@0: EFatConversionDefault = 0, sl@0: /** x-fat.dll is loaded, where is the FAT filename conversion number. */ sl@0: EFatConversionNonStandard = 1, sl@0: /** cp.dll is loaded, where is the FAT filename conversion number. */ sl@0: EFatConversionMicrosoftCodePage = 2 sl@0: }; sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the days of the week. sl@0: sl@0: The enumerator symbol names correspond with the days of the week, sl@0: i.e. EMonday refers to Monday etc. sl@0: */ sl@0: enum TDay sl@0: { sl@0: EMonday, sl@0: ETuesday, sl@0: EWednesday, sl@0: EThursday, sl@0: EFriday, sl@0: ESaturday, sl@0: ESunday sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines the months of the year. sl@0: sl@0: The enumerator symbol names correspond with the months of the year, sl@0: i.e. EJanuary refers to January etc. sl@0: */ sl@0: enum TMonth sl@0: { sl@0: EJanuary, sl@0: EFebruary, sl@0: EMarch, sl@0: EApril, sl@0: EMay, sl@0: EJune, sl@0: EJuly, sl@0: EAugust, sl@0: ESeptember, sl@0: EOctober, sl@0: ENovember, sl@0: EDecember sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Handle ownership flags. sl@0: sl@0: The flags indicate whether a handle being opened is owned by a process or sl@0: a thread. sl@0: sl@0: Ownership by a process means that the handle instance can be used by all sl@0: threads in the process to access the Kernel side object that the sl@0: handle represents. sl@0: sl@0: Ownership by a thread means that the handle instance can only be used by the sl@0: thread that creates or opens the handle. sl@0: sl@0: An enumerator of this type is passed to all member functions of RHandleBase, sl@0: and classes derived from RHandleBase, which open a handle. sl@0: */ sl@0: enum TOwnerType { sl@0: /** sl@0: Ownership of the handle is to be vested in the process. sl@0: */ sl@0: EOwnerProcess, sl@0: sl@0: /** sl@0: Ownership of the handle is to be vested in the thread. sl@0: */ sl@0: EOwnerThread sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: const TInt KCreateProtectedObject = (TInt)0x80000000; sl@0: sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines process priorities. sl@0: sl@0: The enumerator values are passed to RProcess::SetPriority(). sl@0: sl@0: The priorities are listed in relative order stating with the lowest. sl@0: */ sl@0: enum TProcessPriority sl@0: { sl@0: EPriorityLow=150, sl@0: EPriorityBackground=250, sl@0: EPriorityForeground=350, sl@0: EPriorityHigh=450, sl@0: EPriorityWindowServer=650, sl@0: EPriorityFileServer=750, sl@0: EPriorityRealTimeServer=850, sl@0: EPrioritySupervisor=950 sl@0: }; sl@0: sl@0: sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: Defines thread priorities. sl@0: sl@0: The enumerator values are passed to RThread::SetPriority(). sl@0: sl@0: The relative priorities are listed in order starting with the lowest. sl@0: sl@0: The absolute thread priorities are listed in order starting with the lowest. sl@0: */ sl@0: enum TThreadPriority sl@0: { sl@0: EPriorityNull=(-30), sl@0: EPriorityMuchLess=(-20), sl@0: EPriorityLess=(-10), sl@0: EPriorityNormal=0, sl@0: EPriorityMore=10, sl@0: EPriorityMuchMore=20, sl@0: EPriorityRealTime=30, sl@0: EPriorityAbsoluteVeryLow=100, sl@0: EPriorityAbsoluteLowNormal=150, sl@0: EPriorityAbsoluteLow=200, sl@0: EPriorityAbsoluteBackgroundNormal=250, sl@0: EPriorityAbsoluteBackground=300, sl@0: EPriorityAbsoluteForegroundNormal=350, sl@0: EPriorityAbsoluteForeground=400, sl@0: EPriorityAbsoluteHighNormal=450, sl@0: EPriorityAbsoluteHigh=500, sl@0: EPriorityAbsoluteRealTime1=810, sl@0: EPriorityAbsoluteRealTime2=820, sl@0: EPriorityAbsoluteRealTime3=830, sl@0: EPriorityAbsoluteRealTime4=840, sl@0: EPriorityAbsoluteRealTime5=850, sl@0: EPriorityAbsoluteRealTime6=860, sl@0: EPriorityAbsoluteRealTime7=870, sl@0: EPriorityAbsoluteRealTime8=880 sl@0: }; sl@0: sl@0: sl@0: /** sl@0: @publishedAll sl@0: @released sl@0: sl@0: A list of exception types which a thread's exception handler might deal with. sl@0: An enumerator of this type is passed to User::IsExceptionHandled() sl@0: and User::RaiseException(). sl@0: sl@0: While an exception handler can deal with exceptions as listed in the exception sl@0: constants set, a TExcType is simply a type of exception. sl@0: For example, EExcIntegerDivideByZero and EExcIntegerOverflow are types sl@0: of KExceptionInteger exception. sl@0: */ sl@0: enum TExcType sl@0: { sl@0: EExcGeneral=0, /// sl@0: sl@0: #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS sl@0: #include sl@0: #endif sl@0: sl@0: #endif