|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE concept |
|
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
|
12 <concept id="GUID-44F4089F-7184-5F73-A01E-E0F639D32EA1" xml:lang="en"><title>System |
|
13 Wide Error Codes Overview</title><shortdesc>This is an overview document of error codes used system APIs. </shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <section id="GUID-6B6D8FFA-DF27-44D5-AEBF-5CCC81D4C39F"><title>Purpose</title> <p>Provides a core set of error codes that |
|
15 may be returned by System APIs. They are defined in e32err.h. </p> </section> |
|
16 <section id="GUID-B103B96A-B168-4F3C-821B-AF56D0E35643"><title>Description</title> <p>These error codes are used by System |
|
17 APIs to indicate common mathematical, file, communications, and client/server |
|
18 errors. These error codes are intended to be generic to reflect the fact that |
|
19 many error conditions occur for similar reasons in nearly all software components. |
|
20 The errors may also be returned by non-System APIs where appropriate. APIs |
|
21 may also use additional error codes where the core set is not sufficient. </p> <p>Error |
|
22 codes are returned to clients in three circumstances: </p> <ul> |
|
23 <li id="GUID-ED9D2507-15E4-528B-AF04-3D0CC21F758D"><p>as a simple <xref href="GUID-7A2A43EC-6125-3BFE-834B-23C37F7B40D5.dita"><apiname>TInt</apiname></xref> return |
|
24 value from a synchronous function </p> </li> |
|
25 <li id="GUID-50CC41C2-6EA7-5DCB-A4B8-5092A15A1C53"><p>as a leave code from |
|
26 a leaving function, which can be caught in a trap harness </p> </li> |
|
27 <li id="GUID-2D401685-8851-574B-A672-47DFAF9F3C52"><p>in a request status, |
|
28 when an asynchronous request function completes </p> </li> |
|
29 </ul> <p>The complete list can be found at e32err.h. This not only describes |
|
30 the symbols used in C++ code, but also the numerical values that those symbols |
|
31 represent. </p> <p>In the code itself, the core list is defined in the header |
|
32 file <filepath>e32err.h</filepath>. </p> </section> |
|
33 <section id="GUID-9B23BFC3-25DB-4578-ABB1-AF4E38431967"><title>See also</title> <p><xref href="GUID-1294F540-FDA7-5050-BAFB-3C9888491B98.dita">Asynchronous |
|
34 Services Overview</xref> </p> <p><xref href="GUID-E5A83EF3-948B-5729-A2CD-3644E803520B.dita">Cleanup |
|
35 Support Overview</xref> </p> </section> |
|
36 </conbody></concept> |