epoc32/include/e32err.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     1 // Copyright (c) 1994-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // 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
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // e32\include\e32err.h
    15 // 
    16 //
    17 
    18 
    19 
    20 /**
    21  @file
    22  @publishedAll
    23  @released
    24 */
    25 
    26 #ifndef __E32ERR_H__
    27 #define __E32ERR_H__
    28 #include <e32def.h>
    29 
    30 
    31 
    32 
    33 /**
    34 System wide error code 0 : this represents the no-error condition.
    35 
    36 A system wide error code indicates an error in the environment, or in
    37 user input from which a program may recover.
    38 */
    39 const TInt KErrNone=0;                   
    40 
    41 
    42 
    43 
    44 /**
    45 System wide error code -1 : item not found.
    46 
    47 A system wide error code indicates an error in the environment, or in
    48 user input from which a program may recover.
    49 */
    50 const TInt KErrNotFound=(-1); // Must remain set to -1
    51 
    52 
    53 
    54 
    55 /**
    56 System wide error code -2 : an error that has no specific categorisation.
    57 
    58 A system wide error code indicates an error in the environment, or in
    59 user input from which a program may recover.
    60 */
    61 const TInt KErrGeneral=(-2);
    62 
    63 
    64 
    65 
    66 /**
    67 System wide error code -3 : indicates an operation that has been cancelled.
    68 
    69 A system wide error code indicates an error in the environment, or in
    70 user input from which a program may recover.
    71 */
    72 const TInt KErrCancel=(-3);
    73 
    74 
    75 
    76 
    77 /**
    78 System wide error code -4 : an attempt to allocate memory has failed.
    79 
    80 A system wide error code indicates an error in the environment, or in
    81 user input from which a program may recover.
    82 */
    83 const TInt KErrNoMemory=(-4);
    84 
    85 
    86 
    87 
    88 /**
    89 System wide error code -5 : some functionality is not supported in a given context.
    90 
    91 A system wide error code indicates an error in the environment, or in
    92 user input from which a program may recover.
    93 
    94 There may be many reasons for this; for example, a device may not support
    95 some specific behaviour.
    96 */
    97 const TInt KErrNotSupported=(-5);
    98 
    99 
   100 
   101 
   102 /**
   103 System wide error code -6 : an argument is out of range.
   104 
   105 A system wide error code indicates an error in the environment, or in
   106 user input from which a program may recover.
   107 */
   108 const TInt KErrArgument=(-6);
   109 
   110 
   111 
   112 
   113 /**
   114 System wide error code -7 : a calculation has lost precision.
   115 
   116 A system wide error code indicates an error in the environment, or in
   117 user input from which a program may recover.
   118 
   119 This error arises when converting from an internal 96-bit real representation
   120 to a TReal32; the exponent of the internal representation is so small
   121 that the 32-bit real cannot contain it.
   122 */
   123 const TInt KErrTotalLossOfPrecision=(-7);
   124 
   125 
   126 
   127 
   128 /**
   129 System wide error code -8 : an invalid handle has been passed.
   130 
   131 A system wide error code indicates an error in the environment, or in
   132 user input from which a program may recover.
   133 
   134 A function involving a resource owned by a server or the kernel has
   135 specified an invalid handle.
   136 */
   137 const TInt KErrBadHandle=(-8);
   138 
   139 
   140 
   141 
   142 /**
   143 System wide error code -9 : indicates an overflow in some operation.
   144 
   145 A system wide error code indicates an error in the environment, or in
   146 user input from which a program may recover.
   147 
   148 In the context of mathematical or time/date functions, indicates a calculation
   149 that has produced arithmetic overflow exceeding the bounds allowed by
   150 the representation.
   151 
   152 In the context of data transfer, indicates that a buffer has over-filled
   153 without being emptied soon enough.
   154 */
   155 const TInt KErrOverflow=(-9);
   156 
   157 
   158 
   159 
   160 /**
   161 System wide error code -10 : indicates an underflow in some operation.
   162 
   163 A system wide error code indicates an error in the environment, or in
   164 user input from which a program may recover.
   165 
   166 In the context of mathematical or time/date functions, indicates a calculation
   167 that has produced a result smaller than the smallest magnitude of
   168 a finite number allowed by the representation.
   169 
   170 In the context of data transfer, indicates that a buffer was under-filled
   171 when data was required.
   172 */
   173 const TInt KErrUnderflow=(-10);
   174 
   175 
   176 
   177 
   178 /**
   179 System wide error code -11 : an object already exists.
   180 
   181 A system wide error code indicates an error in the environment, or in
   182 user input from which a program may recover.
   183 
   184 An object of some name/type is to be created, but an object of
   185 that name/type already exists.
   186 */
   187 const TInt KErrAlreadyExists=(-11);
   188 
   189 
   190 
   191 
   192 /**
   193 System wide error code -12 : in the context of file operations, a path
   194 was not found.
   195 
   196 A system wide error code indicates an error in the environment, or in
   197 user input from which a program may recover.
   198 */
   199 const TInt KErrPathNotFound=(-12);
   200 
   201 
   202 
   203 
   204 /**
   205 System wide error code -13 : a handle refers to a thread that has died.
   206 
   207 A system wide error code indicates an error in the environment, or in
   208 user input from which a program may recover.
   209 */
   210 const TInt KErrDied=(-13);
   211 
   212 
   213 
   214 
   215 /**
   216 System wide error code -14 : a requested resource is already in exclusive use.
   217 
   218 A system wide error code indicates an error in the environment, or in
   219 user input from which a program may recover.
   220 */
   221 const TInt KErrInUse=(-14);
   222 
   223 
   224 
   225 
   226 /**
   227 System wide error code -15 : client/server send/receive operation cannot run,
   228 because the server has terminated.
   229 
   230 A system wide error code indicates an error in the environment, or in
   231 user input from which a program may recover.
   232 */
   233 const TInt KErrServerTerminated=(-15);
   234 
   235 
   236 
   237 
   238 /**
   239 System wide error code -16 : a client/server send/receive operation cannot run,
   240 because the server is busy handling another request.
   241 
   242 A system wide error code indicates an error in the environment, or in
   243 user input from which a program may recover.
   244 */
   245 const TInt KErrServerBusy=(-16);
   246 
   247 
   248 
   249 
   250 /**
   251 System wide error code -17 : indicates that an operation is complete,
   252 successfully or otherwise.
   253 
   254 A system wide error code indicates an error in the environment, or in
   255 user input from which a program may recover.
   256 
   257 This code may be used to indicate that some follow on operation can take place.
   258 It does not necessarily indicate an error condition.
   259 */
   260 const TInt KErrCompletion=(-17);
   261 
   262 
   263 
   264 
   265 /**
   266 System wide error code -18 : indicates that a device required by an i/o operation
   267 is not ready to start operations.
   268 
   269 A system wide error code indicates an error in the environment, or in
   270 user input from which a program may recover.
   271 
   272 A common reason for returning this code is because a device has not been
   273 initialised, or has no power.
   274 */
   275 const TInt KErrNotReady=(-18);
   276 
   277 
   278 
   279 
   280 /**
   281 System wide error code -19 : a device is of unknown type.
   282 
   283 A system wide error code indicates an error in the environment, or in
   284 user input from which a program may recover.
   285 */
   286 const TInt KErrUnknown=(-19);
   287 
   288 
   289 
   290 
   291 /**
   292 System wide error code -20 : indicates that some media is not formatted properly,
   293 or links between sections of it have been corrupted.
   294 
   295 A system wide error code indicates an error in the environment, or in
   296 user input from which a program may recover.
   297 */
   298 const TInt KErrCorrupt=(-20);
   299 
   300 
   301 
   302 
   303 /**
   304 System wide error code -21 : access to a file is denied, because the permissions on
   305 the file do not allow the requested operation to be performed.
   306 
   307 A system wide error code indicates an error in the environment, or in
   308 user input from which a program may recover.
   309 */
   310 const TInt KErrAccessDenied=(-21);
   311 
   312 
   313 
   314 
   315 /**
   316 System wide error code -22 : an operation cannot be performed, because the part
   317 of the file to be read or written is locked.
   318 
   319 A system wide error code indicates an error in the environment, or in
   320 user input from which a program may recover.
   321 */
   322 const TInt KErrLocked=(-22);
   323 
   324 
   325 
   326 
   327 /**
   328 System wide error code -23 : during a file write operation, not all the data
   329 could be written.
   330 
   331 A system wide error code indicates an error in the environment, or in
   332 user input from which a program may recover.
   333 */
   334 const TInt KErrWrite=(-23);
   335 
   336 
   337 
   338 
   339 /**
   340 System wide error code -24 : a volume which was to be used for a file system
   341 operation has been dismounted.
   342 
   343 A system wide error code indicates an error in the environment, or in
   344 user input from which a program may recover.
   345 */
   346 const TInt KErrDisMounted=(-24);
   347 
   348 
   349 
   350 
   351 /**
   352 System wide error code -25 : indicates that end of file has been reached.
   353 
   354 A system wide error code indicates an error in the environment, or in
   355 user input from which a program may recover.
   356 
   357 Note that RFile::Read() is a higher-level interface. When the end of
   358 the file is reached, it returns zero bytes in the destination descriptor, and
   359 a KErrNone return value. KErrEof is not used for this purpose; other error
   360 conditions are returned only if some other error condition was indicated on
   361 the file.
   362 */
   363 const TInt KErrEof=(-25);
   364 
   365 
   366 
   367 
   368 /**
   369 System wide error code -26 : a write operation cannot complete, because the disk
   370 is full.
   371 
   372 A system wide error code indicates an error in the environment, or in
   373 user input from which a program may recover.
   374 */
   375 const TInt KErrDiskFull=(-26);
   376 
   377 
   378 
   379 
   380 /**
   381 System wide error code -27 : a driver DLL is of the wrong type.
   382 
   383 A system wide error code indicates an error in the environment, or in
   384 user input from which a program may recover.
   385 */
   386 const TInt KErrBadDriver=(-27);
   387 
   388 
   389 
   390 
   391 /**
   392 System wide error code -28 : a file name or other object name does not conform to
   393 the required syntax.
   394 
   395 A system wide error code indicates an error in the environment, or in
   396 user input from which a program may recover.
   397 */
   398 const TInt KErrBadName=(-28);
   399 
   400 
   401 
   402 
   403 /**
   404 System wide error code -29 : a communication line has failed.
   405 
   406 A system wide error code indicates an error in the environment, or in
   407 user input from which a program may recover.
   408 */
   409 const TInt KErrCommsLineFail=(-29);
   410 
   411 
   412 
   413 
   414 /**
   415 System wide error code -30 : a frame error has occurred in
   416 a communications operation.
   417 
   418 A system wide error code indicates an error in the environment, or in
   419 user input from which a program may recover.
   420 */
   421 const TInt KErrCommsFrame=(-30);
   422 
   423 
   424 
   425 
   426 /**
   427 System wide error code -31 : an overrun has been detected by
   428 a communications driver.
   429 
   430 A system wide error code indicates an error in the environment, or in
   431 user input from which a program may recover.
   432 */
   433 const TInt KErrCommsOverrun=(-31);
   434 
   435 
   436 
   437 
   438 /**
   439 System wide error code -32 : a parity error has occurred in communications.
   440 
   441 A system wide error code indicates an error in the environment, or in
   442 user input from which a program may recover.
   443 */
   444 const TInt KErrCommsParity=(-32);
   445 
   446 
   447 
   448 
   449 /**
   450 System wide error code -33 : an operation has timed out.
   451 
   452 A system wide error code indicates an error in the environment, or in
   453 user input from which a program may recover.
   454 */
   455 const TInt KErrTimedOut=(-33);
   456 
   457 
   458 
   459 
   460 /**
   461 System wide error code -34 : a session could not connect.
   462 
   463 A system wide error code indicates an error in the environment, or in
   464 user input from which a program may recover.
   465 */
   466 const TInt KErrCouldNotConnect=(-34);
   467 
   468 
   469 
   470 
   471 /**
   472 System wide error code -35 : a session could not disconnect.
   473 
   474 A system wide error code indicates an error in the environment, or in
   475 user input from which a program may recover.
   476 */
   477 const TInt KErrCouldNotDisconnect=(-35);
   478 
   479 
   480 
   481 
   482 /**
   483 System wide error code -36 : a function could not be executed because the required
   484 session was disconnected.
   485 
   486 A system wide error code indicates an error in the environment, or in
   487 user input from which a program may recover.
   488 */
   489 const TInt KErrDisconnected=(-36);
   490 
   491 
   492 
   493 
   494 /**
   495 System wide error code -37 : a library entry point was not of the required type.
   496 
   497 A system wide error code indicates an error in the environment, or in
   498 user input from which a program may recover.
   499 */
   500 const TInt KErrBadLibraryEntryPoint=(-37);
   501 
   502 
   503 
   504 
   505 /**
   506 System wide error code -38 : a non-descriptor parameter was passed by
   507 a client interface, when a server expected a descriptor.
   508 
   509 A system wide error code indicates an error in the environment, or in
   510 user input from which a program may recover.
   511 */
   512 const TInt KErrBadDescriptor=(-38);
   513 
   514 
   515 
   516 
   517 /**
   518 System wide error code -39 : an operation has been aborted.
   519 
   520 A system wide error code indicates an error in the environment, or in
   521 user input from which a program may recover.
   522 */
   523 const TInt KErrAbort=(-39);
   524 
   525 
   526 
   527 
   528 /**
   529 System wide error code -40 : a number was too big.
   530 
   531 A system wide error code indicates an error in the environment, or in
   532 user input from which a program may recover.
   533 */
   534 const TInt KErrTooBig=(-40);
   535 
   536 
   537 
   538 
   539 /**
   540 System wide error code -41 : a divide-by-zero operation has been attempted.
   541 
   542 A system wide error code indicates an error in the environment, or in
   543 user input from which a program may recover.
   544 */
   545 const TInt KErrDivideByZero=(-41);		// Added by AnnW
   546 
   547 
   548 
   549 
   550 /**
   551 System wide error code -42 : insufficient power was available to
   552 complete an operation.
   553 
   554 A system wide error code indicates an error in the environment, or in
   555 user input from which a program may recover.
   556 */
   557 const TInt KErrBadPower=(-42);
   558 
   559 
   560 
   561 
   562 /**
   563 System wide error code -43 : an operation on a directory has failed.
   564 
   565 A system wide error code indicates an error in the environment, or in
   566 user input from which a program may recover.
   567 */
   568 const TInt KErrDirFull=(-43);
   569 
   570 
   571 
   572 
   573 /**
   574 System wide error code -44 : an operation cannot be performed because
   575 the necessary hardware is not available.
   576 
   577 A system wide error code indicates an error in the environment, or in
   578 user input from which a program may recover.
   579 */
   580 const TInt KErrHardwareNotAvailable=(-44);
   581 
   582 
   583 
   584 
   585 /**
   586 System wide error code -45 : the completion status when an outstanding
   587 client/server message is completed because a shared session has been closed.
   588 
   589 A system wide error code indicates an error in the environment, or in
   590 user input from which a program may recover.
   591 */
   592 const TInt KErrSessionClosed=(-45);
   593 
   594 
   595 
   596 
   597 /**
   598 System wide error code -46 : an operation cannot be performed due to
   599 a potential security violation.
   600 
   601 A system wide error code indicates an error in the environment, or in
   602 user input from which a program may recover.
   603 */
   604 const TInt KErrPermissionDenied=(-46);
   605 
   606 
   607 
   608 /**
   609 System wide error code -47 : a requested extension function is not
   610 supported by the object concerned.
   611 
   612 */
   613 const TInt KErrExtensionNotSupported=(-47);
   614 
   615 
   616 
   617 /**
   618 System wide error code -48 : a break has occurred in
   619 a communications operation.
   620 
   621 A system wide error code indicates an error in the environment, or in
   622 user input from which a program may recover.
   623 */
   624 const TInt KErrCommsBreak=(-48);
   625 
   626 
   627 /**
   628 System wide error code -49 : a trusted time source could not be found
   629 and any time value given in conjunction with this error code should 
   630 not be trusted as correct.
   631 */
   632 const TInt KErrNoSecureTime =(-49);
   633 
   634 #endif