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