// 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\e32err.h

// 

//

/**

 @file

 @publishedAll

 @released

*/

#ifndef __E32ERR_H__

#define __E32ERR_H__

#include <e32def.h>

#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <e32def_private.h>

#endif

/**

System wide error code 0 : this represents the no-error condition.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrNone=0;                   

/**

System wide error code -1 : item not found.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrNotFound=(-1); // Must remain set to -1

/**

System wide error code -2 : an error that has no specific categorisation.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrGeneral=(-2);

/**

System wide error code -3 : indicates an operation that has been cancelled.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrCancel=(-3);

/**

System wide error code -4 : an attempt to allocate memory has failed.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrNoMemory=(-4);

/**

System wide error code -5 : some functionality is not supported in a given context.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

There may be many reasons for this; for example, a device may not support

some specific behaviour.

*/

const TInt KErrNotSupported=(-5);

/**

System wide error code -6 : an argument is out of range.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrArgument=(-6);

/**

System wide error code -7 : a calculation has lost precision.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

This error arises when converting from an internal 96-bit real representation

to a TReal32; the exponent of the internal representation is so small

that the 32-bit real cannot contain it.

*/

const TInt KErrTotalLossOfPrecision=(-7);

/**

System wide error code -8 : an invalid handle has been passed.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

A function involving a resource owned by a server or the kernel has

specified an invalid handle.

*/

const TInt KErrBadHandle=(-8);

/**

System wide error code -9 : indicates an overflow in some operation.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

In the context of mathematical or time/date functions, indicates a calculation

that has produced arithmetic overflow exceeding the bounds allowed by

the representation.

In the context of data transfer, indicates that a buffer has over-filled

without being emptied soon enough.

*/

const TInt KErrOverflow=(-9);

/**

System wide error code -10 : indicates an underflow in some operation.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

In the context of mathematical or time/date functions, indicates a calculation

that has produced a result smaller than the smallest magnitude of

a finite number allowed by the representation.

In the context of data transfer, indicates that a buffer was under-filled

when data was required.

*/

const TInt KErrUnderflow=(-10);

/**

System wide error code -11 : an object already exists.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

An object of some name/type is to be created, but an object of

that name/type already exists.

*/

const TInt KErrAlreadyExists=(-11);

/**

System wide error code -12 : in the context of file operations, a path

was not found.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrPathNotFound=(-12);

/**

System wide error code -13 : a handle refers to a thread that has died.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrDied=(-13);

/**

System wide error code -14 : a requested resource is already in exclusive use.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrInUse=(-14);

/**

System wide error code -15 : client/server send/receive operation cannot run,

because the server has terminated.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrServerTerminated=(-15);

/**

System wide error code -16 : a client/server send/receive operation cannot run,

because the server is busy handling another request.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrServerBusy=(-16);

/**

System wide error code -17 : indicates that an operation is complete,

successfully or otherwise.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

This code may be used to indicate that some follow on operation can take place.

It does not necessarily indicate an error condition.

*/

const TInt KErrCompletion=(-17);

/**

System wide error code -18 : indicates that a device required by an i/o operation

is not ready to start operations.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

A common reason for returning this code is because a device has not been

initialised, or has no power.

*/

const TInt KErrNotReady=(-18);

/**

System wide error code -19 : a device is of unknown type.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrUnknown=(-19);

/**

System wide error code -20 : indicates that some media is not formatted properly,

or links between sections of it have been corrupted.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrCorrupt=(-20);

/**

System wide error code -21 : access to a file is denied, because the permissions on

the file do not allow the requested operation to be performed.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrAccessDenied=(-21);

/**

System wide error code -22 : an operation cannot be performed, because the part

of the file to be read or written is locked.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrLocked=(-22);

/**

System wide error code -23 : during a file write operation, not all the data

could be written.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrWrite=(-23);

/**

System wide error code -24 : a volume which was to be used for a file system

operation has been dismounted.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrDisMounted=(-24);

/**

System wide error code -25 : indicates that end of file has been reached.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

Note that RFile::Read() is a higher-level interface. When the end of

the file is reached, it returns zero bytes in the destination descriptor, and

a KErrNone return value. KErrEof is not used for this purpose; other error

conditions are returned only if some other error condition was indicated on

the file.

*/

const TInt KErrEof=(-25);

/**

System wide error code -26 : a write operation cannot complete, because the disk

is full.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrDiskFull=(-26);

/**

System wide error code -27 : a driver DLL is of the wrong type.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrBadDriver=(-27);

/**

System wide error code -28 : a file name or other object name does not conform to

the required syntax.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrBadName=(-28);

/**

System wide error code -29 : a communication line has failed.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrCommsLineFail=(-29);

/**

System wide error code -30 : a frame error has occurred in

a communications operation.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrCommsFrame=(-30);

/**

System wide error code -31 : an overrun has been detected by

a communications driver.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrCommsOverrun=(-31);

/**

System wide error code -32 : a parity error has occurred in communications.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrCommsParity=(-32);

/**

System wide error code -33 : an operation has timed out.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrTimedOut=(-33);

/**

System wide error code -34 : a session could not connect.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrCouldNotConnect=(-34);

/**

System wide error code -35 : a session could not disconnect.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrCouldNotDisconnect=(-35);

/**

System wide error code -36 : a function could not be executed because the required

session was disconnected.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrDisconnected=(-36);

/**

System wide error code -37 : a library entry point was not of the required type.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrBadLibraryEntryPoint=(-37);

/**

System wide error code -38 : a non-descriptor parameter was passed by

a client interface, when a server expected a descriptor.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrBadDescriptor=(-38);

/**

System wide error code -39 : an operation has been aborted.

A system wide error code indicates an error in the environment, or in

user input from which a program may recover.

*/

const TInt KErrAbort=(-39);

/**

System wide error code -40 : a number was too big.