epoc32/include/xml/xmlframeworkerrors.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 2003-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 //
    15 
    16 #ifndef __XMLFRAMEWORKERRORS_H__
    17 #define __XMLFRAMEWORKERRORS_H__
    18 
    19 /**
    20 @file
    21 
    22 This file contains allocated error codes and
    23 generic Panic error messages and the Panic function.
    24 The XmlFramework has been allocated error codes in the range: -17550 to -17599 
    25 
    26 @publishedAll
    27 @released
    28 */
    29 
    30 #include <e32base.h>
    31 
    32 namespace Xml
    33 {
    34 
    35 // Leave Codes
    36 
    37 // ECom related
    38 
    39 const TInt KErrXmlStringDictionaryPluginNotFound	= -17550;
    40 const TInt KErrXmlParserPluginNotFound				= -17551;
    41 const TInt KErrXmlGeneratorPluginNotFound			= -17552;
    42 const TInt KErrXmlPluginNotFound					= -17553;
    43 
    44 // CCharSetConverter
    45 
    46 const TInt KErrXmlBadCharacterConversion			= -17554;
    47 const TInt KErrXmlUnsupportedCharacterSet			= -17555;
    48 const TInt KErrXmlUnavailableCharacterSet			= -17556;
    49 
    50 // MStringDictionary
    51 
    52 const TInt KErrXmlUnsupportedElement				= -17557;
    53 const TInt KErrXmlUnsupportedAttribute				= -17558;
    54 const TInt KErrXmlUnsupportedAttributeValue			= -17559;
    55 const TInt KErrXmlMissingStringDictionary			= -17560;
    56 
    57 // General
    58 
    59 const TInt KErrXmlUnsupportedDocumentVersion		= -17561;
    60 const TInt KErrXmlDocumentCorrupt					= -17562;
    61 const TInt KErrXmlStringPoolTableNotFound			= -17563;
    62 const TInt KErrXmlBadIndex							= -17564;
    63 const TInt KErrXmlUnsupportedExtInterface			= -17566;
    64 
    65 // Custom resolver related
    66 /**
    67 Indicates the parser query is matched to more than one parser. 
    68 This error can be returned only if the request is to leave in such a case - LeaveOnMany flag is set.
    69 */
    70 const TInt KErrXmlMoreThanOneParserMatched			= -17567;
    71 
    72 const TInt KErrXmlFirst                             = -17550;
    73 const TInt KErrXmlLast                              = -17599;
    74 
    75 // Panic Codes
    76 
    77 /**
    78 Indicates various Panic error conditions within the framework.
    79 
    80 @internalTechnology
    81 */
    82 enum TXmlFrameworkPanic
    83 	{
    84 	/**
    85 	Indicates that a leave code other than that expected was received.
    86 	*/
    87 	EXmlFrameworkPanicUnexpectedLeaveCode		= 0,
    88 
    89 	/**
    90 	Indicates that a state other than that expected was reached.
    91 	*/
    92 	EXmlFrameworkPanicUnexpectedState			= 1,
    93 
    94 	/**
    95 	Indicates that logic other than that expected was reached.
    96 	*/
    97 	EXmlFrameworkPanicUnexpectedLogic			= 2,
    98 
    99 	/**
   100 	Indicates that internal document positioning has gone beyond EOF and has failed.
   101 	*/
   102 	EXmlFrameworkPanicPositionMisallignment		= 3,
   103 
   104 	/**
   105 	Indicates that a reference count has reached a negative value.
   106 	*/
   107 	EXmlFrameworkPanicReferenceCountNegative	= 4,
   108 
   109 	/**
   110 	Pointer is null, cannot dereference.
   111 	*/
   112 	EXmlFrameworkPanicNullPointer				= 5,
   113 
   114 	};
   115 
   116 /**
   117 This method panics the thread
   118 
   119 @param aError The reason for the panic
   120 @internalTechnology
   121 */
   122 void Panic(TXmlFrameworkPanic aError);
   123 
   124 
   125 }
   126 
   127 
   128 #endif // __XMLFRAMEWORKERRORS_H__