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