// Copyright (c) 1994-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of the License "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// e32\include\e32const.h

// 

//

#ifndef __E32CONST_H__

#define __E32CONST_H__

#include <e32err.h>

#include <e32lang.h>

#include <e32reg.h>

/**

@publishedAll

@released

The default width value used when appending and justifying data

in a descriptor.

@see TDes16::AppendJustify()

@see TDes16::Justify()

@see TDes8::AppendJustify()

@see TDes8::Justify()

*/

const TInt KDefaultJustifyWidth=(-1);

/**

@publishedAll

@released

Defines the number of TUids that form a TUidType.

@see TUid

@see TUidType

*/

const TInt KMaxCheckedUid=3;

/**

@publishedAll

@released

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

*/

const TInt KNumTraceMaskWords = 8;

/**

@publishedAll

@released

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

@see TUidName

@see TUid::Name()

*/

const TInt KMaxUidName=10;

/**

@publishedAll

@released

Defines the maximum length of a module name.

*/

const TInt KMaxModuleVersionName=10;

/**

@publishedAll

@released

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

@see TName

*/

const TInt KMaxName=0x80;

/**

@publishedAll

@released

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

*/

const TInt KMaxKernelName=0x50;

/**

@publishedAll

@released

Defines the maximum size of a process name.

*/

const TInt KMaxProcessName=(KMaxKernelName-KMaxUidName-KMaxModuleVersionName-4);

/**

@publishedAll

@released

Defines the maximum size of a library name.

*/

const TInt KMaxLibraryName=(KMaxKernelName-KMaxUidName-KMaxModuleVersionName);

/**

@publishedAll

@released

Defines the maximum length of a TInfoName object.

*/

const TInt KMaxInfoName=0x10;

/**

@publishedAll

@released

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

@see TFullName

*/

const TInt KMaxFullName=(KMaxName<<1);

/**

@publishedAll

@released

The maximum length for a password buffer.

@see TPassword

*/

const TInt KMaxPassword=0x10;

/**

@publishedAll

@released

The maximum length of a category name.

@see TExitCategoryName

*/

const TInt KMaxExitCategoryName=0x10;

/**

@publishedAll

@released

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

@see TDayName

*/

const TInt KMaxDayName=0x20;

/**

@publishedAll

@released

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

@see TDayNameAbb

*/

const TInt KMaxDayNameAbb=0x08;

/**

@publishedAll

@released

Defines the maximum size of arrays or data structures required

to hold the names of the days of the week.

*/

const TInt KMaxDays=7;

/**

@publishedAll

@released

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

@see TDayName

*/

const TInt KMaxMonthName=0x20;

/**

@publishedAll

@released

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

@see TMonthNameAbb

*/

const TInt KMaxMonthNameAbb=0x08;

/**

@publishedAll

@released

Defines the maximum size of arrays or data structures required

to hold the names of the months of the year.

*/

const TInt KMaxMonths=12;

/**

@publishedAll

@released

The maximum length of the text for a date suffix.

@see TDateSuffix

*/

const TInt KMaxSuffix=0x04;

/**

@publishedAll

@released

Defines the maximum size of arrays and data structures required

to hold date suffix strings.

*/

const TInt KMaxSuffixes=31;

/**

@publishedAll

@released

The maximum length of the text for AM and PM.

@see TAmPmName

*/

const TInt KMaxAmPmName=0x04;

/**

@publishedAll

@released

Defines the maximum size of arrays and data structures required

to hold am/pm strings.

*/

const TInt KMaxAmPms=2;

/**

@publishedAll

@released

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

*/

const TInt KMaxDateSeparators=4;

/**

@publishedAll

@released

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

*/

const TInt KMaxTimeSeparators=4;

/**

@publishedAll

@released

Defines the maximum size of data structures to hold the translate tables

for Western European alphabetic conversions.

*/

const TInt KMaxTranslateTable=0x100;

/**

@publishedAll

@released

The maximum length of the text for a currency symbol.

@see TCurrencySymbol

*/

const TInt KMaxCurrencySymbol=0x08;

/**

@publishedAll

@released

The maximum length of the short date format specification text.

@see TShortDateFormatSpec

*/

const TInt KMaxShortDateFormatSpec=40;

/**

@publishedAll

@released

The maximum length of the short date format specification text.

@see TLongDateFormatSpec

*/

const TInt KMaxLongDateFormatSpec=80;

/**

@publishedAll

@released

The maximum length of the time string formatting commands.

@see TTimeFormatSpec

*/

const TInt KMaxTimeFormatSpec=60;

/**

@publishedAll

@released

Defines the maximum length of a filename.

*/

const TInt KMaxFileName=0x100;

/**

@publishedAll

@released

The maximum length of the character representation of version information.

@see TVersion::Name()

*/

const TInt KMaxVersionName=0x10;

/**

@publishedAll

@released

Defines the maximum length of a path.

@see TPath

*/

const TInt KMaxPath=0x100;

/**

@publishedAll

@released

Defines the maximum length of a TDeviceInfo object.

@see TDeviceInfo

*/

const TInt KMaxDeviceInfo=0x80;

/**

@publishedAll

@released

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

*/

const TInt KMaxMediaPassword=16;

/**

@publishedAll

@released

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 UserHeap

@see RThread::Create()

*/

const TInt KMinHeapSize=0x100;

/**

@publishedAll

@released

Not used by Symbian OS.

*/

const TInt KDstHome=0x01;

/**

@publishedAll

@released

Not used by Symbian OS.

*/

const TInt KDstEuropean=0x02;

/**

@publishedAll

@released

Not used by Symbian OS.

*/

const TInt KDstNorthern=0x04;

/**

@publishedAll

@released

Not used by Symbian OS.

*/

const TInt KDstSouthern=0x08;

/**

@publishedAll

@released

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

*/

#ifdef __X86GCC__

const TInt KDefaultStackSize=0x4000;

#else

const TInt KDefaultStackSize=0x2000;

#endif // __X86GCC__

/**

@publishedAll

@released

Indicates an undefined character, used internally when formatting text. 

*/

const TUint KNoChar=0xffffffffu;

/**

@publishedAll

@released

Defines an index value that is interpreted by the TKey class,

and derived classes, as having a specific meaning.

@see TKey::SetPtr()

@see TKey::At()

*/

const TInt KIndexPtr=(-1);

/**

@publishedAll

@released

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

*/

const TInt KHandleNoClose=0x00008000;

/**

@publishedAll

@released

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

*/

const TInt KHandleFlagLocal=0x40000000;

/**

@publishedAll

@released

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

*/

const TInt KCurrentProcessHandle=0xffff0000|KHandleNoClose;

/**

@publishedAll

@released

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

*/

const TInt KCurrentThreadHandle=0xffff0001|KHandleNoClose;

/**

@publishedAll

@released

Defines a handle number value of zero.

@see RHandleBase

*/

const TInt KNullHandle=0;

/**

@publishedAll

@released

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

*/

const TInt KDefaultUnit=0x00;

/**

@publishedAll

@released

The device unit that must be passed in a call

to RBusLogicalChannel::DoCreate(), if units are not permitted.

@see RBusLogicalChannel

*/

const TInt KNullUnit=0xffffffff;

/**

@publishedAll

@released

The maximum unit number that can be passed in a call

to RBusLogicalChannel::DoCreate().

@see RBusLogicalChannel

*/

const TInt KMaxUnits=0x20;

/**

@publishedAll

@released

Defines the maximum number of message arguments that can be passed

across the user side/kernel side boundary.

*/

const TInt KMaxMessageArguments=0x04;

/**

@publishedAll

@released

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 TRealFormat

@see TDes16::AppendFormat()

@see TDes8::AppendFormat()

*/

const TInt KDefaultRealWidth=20;

/**

@publishedAll

@released

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 UserHeap::ChunkHeap()

*/

const TInt KMinHeapGrowBy=0x1000;

/**

@publishedAll

@released

Not used by Symbian OS.

*/

const TInt KMaxExponentConversion=99;

/**

@publishedAll

@released

Defines a Null UID value.

@see TUid

*/

const TInt KNullUidValue=0;

/**

@publishedAll

@deprecated

The timer granularity used by a CDeltaTimer object is

now the tick period and this constant is obsolete.

@see CDeltaTimer

*/

const TInt KDeltaTimerDefaultGranularity=100000;

/**

@publishedAll

@released

The largest possible value for a TInt8.

*/

const TInt KMaxTInt8=0x7f;

/**

@publishedAll

@released

The smallest possible value for a TInt8.

*/

const TInt KMinTInt8=(-128);

/**

@publishedAll

@released

The largest possible value for a TUint8.

*/

const TUint KMaxTUint8=0xffu;

/**

@publishedAll

@released

The largest possible value for a TInt16.

*/

const TInt KMaxTInt16=0x7fff;

/**

@publishedAll

@released

The smallest possible value for a TInt16.

*/

const TInt KMinTInt16=(-32768);

/**

@publishedAll

@released

The largest possible value for a TUint16.

*/

const TUint KMaxTUint16=0xffffu;

/**

@publishedAll

@released

The largest possible value for a TInt32.

*/

const TInt KMaxTInt32=0x7fffffff;

/**

@publishedAll

@released

The smallest possible value for a TInt32.

*/

const TInt KMinTInt32=(TInt)0x80000000;

/**

@publishedAll

@released

The largest possible value for a TUint32.

*/

const TUint KMaxTUint32=0xffffffffu;

/**

@publishedAll

@released

The largest possible value for a TInt.

*/

const TInt KMaxTInt=0x7fffffff;

/**

@publishedAll

@released

The smallest possible value for a TInt.

*/

const TInt KMinTInt=(TInt)0x80000000;

/**

@publishedAll

@released

The largest possible value for a TUint.

*/

const TUint KMaxTUint=0xffffffffu;

/**

@publishedAll

@released

The largest possible value for a TInt64.

*/

const TInt64 KMaxTInt64 = I64LIT(0x7fffffffffffffff);

/**

@publishedAll

@released

The smallest possible value for a TInt64.

*/

const TInt64 KMinTInt64 = UI64LIT(0x8000000000000000);

/**

@publishedAll

@released

The largest possible value for a TUint64.

*/

const TUint64 KMaxTUint64 = UI64LIT(0xffffffffffffffff);

/**

@publishedAll

@released

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 TParse

*/

const TUint KMatchAny='*';

/**

@publishedAll

@released

Defines the character ?, and represents a single character in

a path component, filename or extension.

It is used in a TParse file specification.

@see TParse

*/

const TUint KMatchOne='?';

/**

@publishedAll

@released

Defines the maximum number of local drives.

*/

const TInt KMaxLocalDrives=16;

/**

@publishedAll

@released

Defines the maximum number of peripheral bus sockets.

*/

const TInt KMaxPBusSockets=4;

/**

@publishedAll

@released

Not used by Symbian OS.

*/

const TInt KNoCallEntryPoint = 0x01;

/**

@publishedAll

@released

The value to which CActive::iStatus is set by an active object's

service provider before the service provider initiates an asynchronous request.

@see CActive

*/

const TInt KRequestPending=(-KMaxTInt);

// Drive capabilities

/**

@publishedAll

@released

Defines the possible media types. 

*/

enum TMediaType

	{

	EMediaNotPresent,