1.1 --- a/epoc32/include/e32err.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/e32err.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,634 @@
1.4 -e32err.h
1.5 +// Copyright (c) 1994-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +// All rights reserved.
1.7 +// This component and the accompanying materials are made available
1.8 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.9 +// which accompanies this distribution, and is available
1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +//
1.12 +// Initial Contributors:
1.13 +// Nokia Corporation - initial contribution.
1.14 +//
1.15 +// Contributors:
1.16 +//
1.17 +// Description:
1.18 +// e32\include\e32err.h
1.19 +//
1.20 +//
1.21 +
1.22 +
1.23 +
1.24 +/**
1.25 + @file
1.26 + @publishedAll
1.27 + @released
1.28 +*/
1.29 +
1.30 +#ifndef __E32ERR_H__
1.31 +#define __E32ERR_H__
1.32 +#include <e32def.h>
1.33 +
1.34 +
1.35 +
1.36 +
1.37 +/**
1.38 +System wide error code 0 : this represents the no-error condition.
1.39 +
1.40 +A system wide error code indicates an error in the environment, or in
1.41 +user input from which a program may recover.
1.42 +*/
1.43 +const TInt KErrNone=0;
1.44 +
1.45 +
1.46 +
1.47 +
1.48 +/**
1.49 +System wide error code -1 : item not found.
1.50 +
1.51 +A system wide error code indicates an error in the environment, or in
1.52 +user input from which a program may recover.
1.53 +*/
1.54 +const TInt KErrNotFound=(-1); // Must remain set to -1
1.55 +
1.56 +
1.57 +
1.58 +
1.59 +/**
1.60 +System wide error code -2 : an error that has no specific categorisation.
1.61 +
1.62 +A system wide error code indicates an error in the environment, or in
1.63 +user input from which a program may recover.
1.64 +*/
1.65 +const TInt KErrGeneral=(-2);
1.66 +
1.67 +
1.68 +
1.69 +
1.70 +/**
1.71 +System wide error code -3 : indicates an operation that has been cancelled.
1.72 +
1.73 +A system wide error code indicates an error in the environment, or in
1.74 +user input from which a program may recover.
1.75 +*/
1.76 +const TInt KErrCancel=(-3);
1.77 +
1.78 +
1.79 +
1.80 +
1.81 +/**
1.82 +System wide error code -4 : an attempt to allocate memory has failed.
1.83 +
1.84 +A system wide error code indicates an error in the environment, or in
1.85 +user input from which a program may recover.
1.86 +*/
1.87 +const TInt KErrNoMemory=(-4);
1.88 +
1.89 +
1.90 +
1.91 +
1.92 +/**
1.93 +System wide error code -5 : some functionality is not supported in a given context.
1.94 +
1.95 +A system wide error code indicates an error in the environment, or in
1.96 +user input from which a program may recover.
1.97 +
1.98 +There may be many reasons for this; for example, a device may not support
1.99 +some specific behaviour.
1.100 +*/
1.101 +const TInt KErrNotSupported=(-5);
1.102 +
1.103 +
1.104 +
1.105 +
1.106 +/**
1.107 +System wide error code -6 : an argument is out of range.
1.108 +
1.109 +A system wide error code indicates an error in the environment, or in
1.110 +user input from which a program may recover.
1.111 +*/
1.112 +const TInt KErrArgument=(-6);
1.113 +
1.114 +
1.115 +
1.116 +
1.117 +/**
1.118 +System wide error code -7 : a calculation has lost precision.
1.119 +
1.120 +A system wide error code indicates an error in the environment, or in
1.121 +user input from which a program may recover.
1.122 +
1.123 +This error arises when converting from an internal 96-bit real representation
1.124 +to a TReal32; the exponent of the internal representation is so small
1.125 +that the 32-bit real cannot contain it.
1.126 +*/
1.127 +const TInt KErrTotalLossOfPrecision=(-7);
1.128 +
1.129 +
1.130 +
1.131 +
1.132 +/**
1.133 +System wide error code -8 : an invalid handle has been passed.
1.134 +
1.135 +A system wide error code indicates an error in the environment, or in
1.136 +user input from which a program may recover.
1.137 +
1.138 +A function involving a resource owned by a server or the kernel has
1.139 +specified an invalid handle.
1.140 +*/
1.141 +const TInt KErrBadHandle=(-8);
1.142 +
1.143 +
1.144 +
1.145 +
1.146 +/**
1.147 +System wide error code -9 : indicates an overflow in some operation.
1.148 +
1.149 +A system wide error code indicates an error in the environment, or in
1.150 +user input from which a program may recover.
1.151 +
1.152 +In the context of mathematical or time/date functions, indicates a calculation
1.153 +that has produced arithmetic overflow exceeding the bounds allowed by
1.154 +the representation.
1.155 +
1.156 +In the context of data transfer, indicates that a buffer has over-filled
1.157 +without being emptied soon enough.
1.158 +*/
1.159 +const TInt KErrOverflow=(-9);
1.160 +
1.161 +
1.162 +
1.163 +
1.164 +/**
1.165 +System wide error code -10 : indicates an underflow in some operation.
1.166 +
1.167 +A system wide error code indicates an error in the environment, or in
1.168 +user input from which a program may recover.
1.169 +
1.170 +In the context of mathematical or time/date functions, indicates a calculation
1.171 +that has produced a result smaller than the smallest magnitude of
1.172 +a finite number allowed by the representation.
1.173 +
1.174 +In the context of data transfer, indicates that a buffer was under-filled
1.175 +when data was required.
1.176 +*/
1.177 +const TInt KErrUnderflow=(-10);
1.178 +
1.179 +
1.180 +
1.181 +
1.182 +/**
1.183 +System wide error code -11 : an object already exists.
1.184 +
1.185 +A system wide error code indicates an error in the environment, or in
1.186 +user input from which a program may recover.
1.187 +
1.188 +An object of some name/type is to be created, but an object of
1.189 +that name/type already exists.
1.190 +*/
1.191 +const TInt KErrAlreadyExists=(-11);
1.192 +
1.193 +
1.194 +
1.195 +
1.196 +/**
1.197 +System wide error code -12 : in the context of file operations, a path
1.198 +was not found.
1.199 +
1.200 +A system wide error code indicates an error in the environment, or in
1.201 +user input from which a program may recover.
1.202 +*/
1.203 +const TInt KErrPathNotFound=(-12);
1.204 +
1.205 +
1.206 +
1.207 +
1.208 +/**
1.209 +System wide error code -13 : a handle refers to a thread that has died.
1.210 +
1.211 +A system wide error code indicates an error in the environment, or in
1.212 +user input from which a program may recover.
1.213 +*/
1.214 +const TInt KErrDied=(-13);
1.215 +
1.216 +
1.217 +
1.218 +
1.219 +/**
1.220 +System wide error code -14 : a requested resource is already in exclusive use.
1.221 +
1.222 +A system wide error code indicates an error in the environment, or in
1.223 +user input from which a program may recover.
1.224 +*/
1.225 +const TInt KErrInUse=(-14);
1.226 +
1.227 +
1.228 +
1.229 +
1.230 +/**
1.231 +System wide error code -15 : client/server send/receive operation cannot run,
1.232 +because the server has terminated.
1.233 +
1.234 +A system wide error code indicates an error in the environment, or in
1.235 +user input from which a program may recover.
1.236 +*/
1.237 +const TInt KErrServerTerminated=(-15);
1.238 +
1.239 +
1.240 +
1.241 +
1.242 +/**
1.243 +System wide error code -16 : a client/server send/receive operation cannot run,
1.244 +because the server is busy handling another request.
1.245 +
1.246 +A system wide error code indicates an error in the environment, or in
1.247 +user input from which a program may recover.
1.248 +*/
1.249 +const TInt KErrServerBusy=(-16);
1.250 +
1.251 +
1.252 +
1.253 +
1.254 +/**
1.255 +System wide error code -17 : indicates that an operation is complete,
1.256 +successfully or otherwise.
1.257 +
1.258 +A system wide error code indicates an error in the environment, or in
1.259 +user input from which a program may recover.
1.260 +
1.261 +This code may be used to indicate that some follow on operation can take place.
1.262 +It does not necessarily indicate an error condition.
1.263 +*/
1.264 +const TInt KErrCompletion=(-17);
1.265 +
1.266 +
1.267 +
1.268 +
1.269 +/**
1.270 +System wide error code -18 : indicates that a device required by an i/o operation
1.271 +is not ready to start operations.
1.272 +
1.273 +A system wide error code indicates an error in the environment, or in
1.274 +user input from which a program may recover.
1.275 +
1.276 +A common reason for returning this code is because a device has not been
1.277 +initialised, or has no power.
1.278 +*/
1.279 +const TInt KErrNotReady=(-18);
1.280 +
1.281 +
1.282 +
1.283 +
1.284 +/**
1.285 +System wide error code -19 : a device is of unknown type.
1.286 +
1.287 +A system wide error code indicates an error in the environment, or in
1.288 +user input from which a program may recover.
1.289 +*/
1.290 +const TInt KErrUnknown=(-19);
1.291 +
1.292 +
1.293 +
1.294 +
1.295 +/**
1.296 +System wide error code -20 : indicates that some media is not formatted properly,
1.297 +or links between sections of it have been corrupted.
1.298 +
1.299 +A system wide error code indicates an error in the environment, or in
1.300 +user input from which a program may recover.
1.301 +*/
1.302 +const TInt KErrCorrupt=(-20);
1.303 +
1.304 +
1.305 +
1.306 +
1.307 +/**
1.308 +System wide error code -21 : access to a file is denied, because the permissions on
1.309 +the file do not allow the requested operation to be performed.
1.310 +
1.311 +A system wide error code indicates an error in the environment, or in
1.312 +user input from which a program may recover.
1.313 +*/
1.314 +const TInt KErrAccessDenied=(-21);
1.315 +
1.316 +
1.317 +
1.318 +
1.319 +/**
1.320 +System wide error code -22 : an operation cannot be performed, because the part
1.321 +of the file to be read or written is locked.
1.322 +
1.323 +A system wide error code indicates an error in the environment, or in
1.324 +user input from which a program may recover.
1.325 +*/
1.326 +const TInt KErrLocked=(-22);
1.327 +
1.328 +
1.329 +
1.330 +
1.331 +/**
1.332 +System wide error code -23 : during a file write operation, not all the data
1.333 +could be written.
1.334 +
1.335 +A system wide error code indicates an error in the environment, or in
1.336 +user input from which a program may recover.
1.337 +*/
1.338 +const TInt KErrWrite=(-23);
1.339 +
1.340 +
1.341 +
1.342 +
1.343 +/**
1.344 +System wide error code -24 : a volume which was to be used for a file system
1.345 +operation has been dismounted.
1.346 +
1.347 +A system wide error code indicates an error in the environment, or in
1.348 +user input from which a program may recover.
1.349 +*/
1.350 +const TInt KErrDisMounted=(-24);
1.351 +
1.352 +
1.353 +
1.354 +
1.355 +/**
1.356 +System wide error code -25 : indicates that end of file has been reached.
1.357 +
1.358 +A system wide error code indicates an error in the environment, or in
1.359 +user input from which a program may recover.
1.360 +
1.361 +Note that RFile::Read() is a higher-level interface. When the end of
1.362 +the file is reached, it returns zero bytes in the destination descriptor, and
1.363 +a KErrNone return value. KErrEof is not used for this purpose; other error
1.364 +conditions are returned only if some other error condition was indicated on
1.365 +the file.
1.366 +*/
1.367 +const TInt KErrEof=(-25);
1.368 +
1.369 +
1.370 +
1.371 +
1.372 +/**
1.373 +System wide error code -26 : a write operation cannot complete, because the disk
1.374 +is full.
1.375 +
1.376 +A system wide error code indicates an error in the environment, or in
1.377 +user input from which a program may recover.
1.378 +*/
1.379 +const TInt KErrDiskFull=(-26);
1.380 +
1.381 +
1.382 +
1.383 +
1.384 +/**
1.385 +System wide error code -27 : a driver DLL is of the wrong type.
1.386 +
1.387 +A system wide error code indicates an error in the environment, or in
1.388 +user input from which a program may recover.
1.389 +*/
1.390 +const TInt KErrBadDriver=(-27);
1.391 +
1.392 +
1.393 +
1.394 +
1.395 +/**
1.396 +System wide error code -28 : a file name or other object name does not conform to
1.397 +the required syntax.
1.398 +
1.399 +A system wide error code indicates an error in the environment, or in
1.400 +user input from which a program may recover.
1.401 +*/
1.402 +const TInt KErrBadName=(-28);
1.403 +
1.404 +
1.405 +
1.406 +
1.407 +/**
1.408 +System wide error code -29 : a communication line has failed.
1.409 +
1.410 +A system wide error code indicates an error in the environment, or in
1.411 +user input from which a program may recover.
1.412 +*/
1.413 +const TInt KErrCommsLineFail=(-29);
1.414 +
1.415 +
1.416 +
1.417 +
1.418 +/**
1.419 +System wide error code -30 : a frame error has occurred in
1.420 +a communications operation.
1.421 +
1.422 +A system wide error code indicates an error in the environment, or in
1.423 +user input from which a program may recover.
1.424 +*/
1.425 +const TInt KErrCommsFrame=(-30);
1.426 +
1.427 +
1.428 +
1.429 +
1.430 +/**
1.431 +System wide error code -31 : an overrun has been detected by
1.432 +a communications driver.
1.433 +
1.434 +A system wide error code indicates an error in the environment, or in
1.435 +user input from which a program may recover.
1.436 +*/
1.437 +const TInt KErrCommsOverrun=(-31);
1.438 +
1.439 +
1.440 +
1.441 +
1.442 +/**
1.443 +System wide error code -32 : a parity error has occurred in communications.
1.444 +
1.445 +A system wide error code indicates an error in the environment, or in
1.446 +user input from which a program may recover.
1.447 +*/
1.448 +const TInt KErrCommsParity=(-32);
1.449 +
1.450 +
1.451 +
1.452 +
1.453 +/**
1.454 +System wide error code -33 : an operation has timed out.
1.455 +
1.456 +A system wide error code indicates an error in the environment, or in
1.457 +user input from which a program may recover.
1.458 +*/
1.459 +const TInt KErrTimedOut=(-33);
1.460 +
1.461 +
1.462 +
1.463 +
1.464 +/**
1.465 +System wide error code -34 : a session could not connect.
1.466 +
1.467 +A system wide error code indicates an error in the environment, or in
1.468 +user input from which a program may recover.
1.469 +*/
1.470 +const TInt KErrCouldNotConnect=(-34);
1.471 +
1.472 +
1.473 +
1.474 +
1.475 +/**
1.476 +System wide error code -35 : a session could not disconnect.
1.477 +
1.478 +A system wide error code indicates an error in the environment, or in
1.479 +user input from which a program may recover.
1.480 +*/
1.481 +const TInt KErrCouldNotDisconnect=(-35);
1.482 +
1.483 +
1.484 +
1.485 +
1.486 +/**
1.487 +System wide error code -36 : a function could not be executed because the required
1.488 +session was disconnected.
1.489 +
1.490 +A system wide error code indicates an error in the environment, or in
1.491 +user input from which a program may recover.
1.492 +*/
1.493 +const TInt KErrDisconnected=(-36);
1.494 +
1.495 +
1.496 +
1.497 +
1.498 +/**
1.499 +System wide error code -37 : a library entry point was not of the required type.
1.500 +
1.501 +A system wide error code indicates an error in the environment, or in
1.502 +user input from which a program may recover.
1.503 +*/
1.504 +const TInt KErrBadLibraryEntryPoint=(-37);
1.505 +
1.506 +
1.507 +
1.508 +
1.509 +/**
1.510 +System wide error code -38 : a non-descriptor parameter was passed by
1.511 +a client interface, when a server expected a descriptor.
1.512 +
1.513 +A system wide error code indicates an error in the environment, or in
1.514 +user input from which a program may recover.
1.515 +*/
1.516 +const TInt KErrBadDescriptor=(-38);
1.517 +
1.518 +
1.519 +
1.520 +
1.521 +/**
1.522 +System wide error code -39 : an operation has been aborted.
1.523 +
1.524 +A system wide error code indicates an error in the environment, or in
1.525 +user input from which a program may recover.
1.526 +*/
1.527 +const TInt KErrAbort=(-39);
1.528 +
1.529 +
1.530 +
1.531 +
1.532 +/**
1.533 +System wide error code -40 : a number was too big.
1.534 +
1.535 +A system wide error code indicates an error in the environment, or in
1.536 +user input from which a program may recover.
1.537 +*/
1.538 +const TInt KErrTooBig=(-40);
1.539 +
1.540 +
1.541 +
1.542 +
1.543 +/**
1.544 +System wide error code -41 : a divide-by-zero operation has been attempted.
1.545 +
1.546 +A system wide error code indicates an error in the environment, or in
1.547 +user input from which a program may recover.
1.548 +*/
1.549 +const TInt KErrDivideByZero=(-41); // Added by AnnW
1.550 +
1.551 +
1.552 +
1.553 +
1.554 +/**
1.555 +System wide error code -42 : insufficient power was available to
1.556 +complete an operation.
1.557 +
1.558 +A system wide error code indicates an error in the environment, or in
1.559 +user input from which a program may recover.
1.560 +*/
1.561 +const TInt KErrBadPower=(-42);
1.562 +
1.563 +
1.564 +
1.565 +
1.566 +/**
1.567 +System wide error code -43 : an operation on a directory has failed.
1.568 +
1.569 +A system wide error code indicates an error in the environment, or in
1.570 +user input from which a program may recover.
1.571 +*/
1.572 +const TInt KErrDirFull=(-43);
1.573 +
1.574 +
1.575 +
1.576 +
1.577 +/**
1.578 +System wide error code -44 : an operation cannot be performed because
1.579 +the necessary hardware is not available.
1.580 +
1.581 +A system wide error code indicates an error in the environment, or in
1.582 +user input from which a program may recover.
1.583 +*/
1.584 +const TInt KErrHardwareNotAvailable=(-44);
1.585 +
1.586 +
1.587 +
1.588 +
1.589 +/**
1.590 +System wide error code -45 : the completion status when an outstanding
1.591 +client/server message is completed because a shared session has been closed.
1.592 +
1.593 +A system wide error code indicates an error in the environment, or in
1.594 +user input from which a program may recover.
1.595 +*/
1.596 +const TInt KErrSessionClosed=(-45);
1.597 +
1.598 +
1.599 +
1.600 +
1.601 +/**
1.602 +System wide error code -46 : an operation cannot be performed due to
1.603 +a potential security violation.
1.604 +
1.605 +A system wide error code indicates an error in the environment, or in
1.606 +user input from which a program may recover.
1.607 +*/
1.608 +const TInt KErrPermissionDenied=(-46);
1.609 +
1.610 +
1.611 +
1.612 +/**
1.613 +System wide error code -47 : a requested extension function is not
1.614 +supported by the object concerned.
1.615 +
1.616 +*/
1.617 +const TInt KErrExtensionNotSupported=(-47);
1.618 +
1.619 +
1.620 +
1.621 +/**
1.622 +System wide error code -48 : a break has occurred in
1.623 +a communications operation.
1.624 +
1.625 +A system wide error code indicates an error in the environment, or in
1.626 +user input from which a program may recover.
1.627 +*/
1.628 +const TInt KErrCommsBreak=(-48);
1.629 +
1.630 +
1.631 +/**
1.632 +System wide error code -49 : a trusted time source could not be found
1.633 +and any time value given in conjunction with this error code should
1.634 +not be trusted as correct.
1.635 +*/
1.636 +const TInt KErrNoSecureTime =(-49);
1.637 +
1.638 +#endif