epoc32/include/ecom/ecomerrorcodes.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     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
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    12 //
    12 //
    13 // Description:
    13 // Description:
    14 // All the error codes returned by
    14 // All the ECOM specific error codes returned by the ECOM API to a client
    15 // the ECOM framework to a client 
       
    16 // are defined here.
    15 // are defined here.
    17 // 
    16 // 
    18 //
    17 //
    19 
    18 
    20 
    19 /**
       
    20  @file
       
    21  @publishedAll
       
    22  @released
       
    23 */
    21 
    24 
    22 #ifndef __ECOMERRORCODES_H__
    25 #ifndef __ECOMERRORCODES_H__
    23 #define __ECOMERRORCODES_H__
    26 #define __ECOMERRORCODES_H__
    24 
    27 
    25 /** 
    28 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
    26 The base value for Shared Error codes for the ECOM framework and client 
    29 #include <ecom/ecomextendedinterfaceerrorcodes.h>
    27 @publishedAll
    30 #endif
    28 @released
    31 
       
    32 /**
       
    33 The base value for Shared Error codes for the ECOM framework and client
    29 */
    34 */
    30 const TInt KEComErrBase								= -17000;
    35 const TInt KEComErrBase								= -17000;
    31 
    36 
    32 /** 
    37 /**
    33 The last value for ECom Frmework errors
    38 The last value for ECom Frmework errors
    34 This must be modified when error codes are added/deleted
    39 This must be modified when error codes are added/deleted
    35 @publishedAll
       
    36 @released
       
    37 */
    40 */
    38 const TInt KEComErrLast								= -17030;
    41 const TInt KEComErrLast								= -17033;
    39 
    42 
    40 ////////////////////////////////////////////////////////////
    43 //
    41 // Error codes which may be received by a client application
    44 // Error codes which may be received by a client application
    42 ////////////////////////////////////////////////////////////
    45 //
    43 /** 
    46 /**
    44 The call to instantiate an Interface Implementation failed 
    47 The call to instantiate an Interface Implementation failed
    45 because no registrations exist for this interface. 
    48 because no registrations exist for this interface.
    46 @publishedAll
       
    47 @released
       
    48 */
    49 */
    49 const TInt KEComErrNoInterfaceIdentified			= -17004;
    50 const TInt KEComErrNoInterfaceIdentified			= -17004;
    50 
    51 
    51 /** 
    52 /**
    52 The Non-Default resolver could not be instantiated.  The most likely
    53 The Non-Default resolver could not be instantiated.  The most likely
    53 situation is that an incorrect implementation uid was supplied. 
    54 situation is that an incorrect implementation uid was supplied.
    54 @publishedAll
       
    55 @released
       
    56 */
    55 */
    57 const TInt KEComErrNoResolver						= -17014;
    56 const TInt KEComErrNoResolver						= -17014;
    58 
    57 
    59 /** 
    58 /**
    60 The client has requested too many notifications.  ECom can only support
    59 The client has requested too many notifications.  ECom can only support
    61 a finite number of notifications 
    60 a finite number of notifications
    62 @publishedAll
       
    63 @released
       
    64 */
    61 */
    65 const TInt KEComErrTooManyNotificationsOutstanding	= -17026;
    62 const TInt KEComErrTooManyNotificationsOutstanding	= -17026;
    66 
    63 
    67 /** 
    64 /**
    68 An ECom service was requested with an essential parameter missing.  For example,
    65 An ECom service was requested with an essential parameter missing.  For example,
    69 this error code will be supplied when calling an overload of CreateImplementationL 
    66 this error code will be supplied when calling an overload of CreateImplementationL
    70 which uses a non-default resolver if you fail to supply the resolver 
    67 which uses a non-default resolver if you fail to supply the resolver
    71 @publishedAll
       
    72 @released
       
    73 */
    68 */
    74 const TInt KEComErrMissingParameter					= -17028;
    69 const TInt KEComErrMissingParameter					= -17028;
    75 
    70 
    76 /** The registry index is invalid but the client has requested notifications - so
    71 /** The registry index is invalid but the client has requested notifications - so
    77 they will receive a notification when the index is ready again 
    72 they will receive a notification when the index is ready again
    78 @publishedAll
       
    79 @released
       
    80 */
    73 */
    81 const TInt KEComErrListInvalidAwaitNotification		= -17029;
    74 const TInt KEComErrListInvalidAwaitNotification		= -17029;
    82 
    75 
    83 /** 
    76 /**
    84 The registry index is invalid and the client has not requested notifications.
    77 The registry index is invalid and the client has not requested notifications.
    85 They will have to try again later after discoveries have completed. 
    78 They will have to try again later after discoveries have completed.
    86 @publishedAll
       
    87 @released
       
    88 */
    79 */
    89 const TInt KEComErrListCurrentlyUnavailable			= -17030;
    80 const TInt KEComErrListCurrentlyUnavailable			= -17030;
    90 
    81 
    91 
    82 
    92 ////////////////////////////////////////////////////////////
    83 //
    93 // Error codes for internal use only
       
    94 ////////////////////////////////////////////////////////////
       
    95 /** 
       
    96 The Client requested a service which is not supplied by this framework 
       
    97 @publishedAll
       
    98 @released
       
    99 */
       
   100 const TInt KEComErrInvalidUnloadPolicy				= -17003;
       
   101 
       
   102 /** 
       
   103 An attempt has been made to load an implementation contained within a dll
       
   104 which no longer exists (deleted or is on a CF card that has been removed). 
       
   105 @publishedAll
       
   106 @released
       
   107 */
       
   108 const TInt KEComErrInvalidIIC						= -17008;
       
   109 
       
   110 /** 
       
   111 An attempt has been made to update registry information for a dll on a
       
   112 drive that does not exist. 
       
   113 @publishedAll
       
   114 @released
       
   115 */
       
   116 const TInt KEComErrDriveNotFound					= -17019;
       
   117 
       
   118 
       
   119 ////////////////////////////////////////////////////////////
       
   120 // Codes which are only used for Panics
    84 // Codes which are only used for Panics
   121 ////////////////////////////////////////////////////////////
    85 //
   122 /** 
    86 /**
   123 The Client requested a service which is not supplied by this framework 
    87 The Client requested a service which is not supplied by this framework
   124 @publishedAll
       
   125 @released
       
   126 */
    88 */
   127 const TInt KEComErrUnknownService					= -17002;
    89 const TInt KEComErrUnknownService					= -17002;
   128 
    90 
   129 /** 
    91 /**
   130 The Interface Implementation reference count is invalid 
    92 The Interface Implementation reference count is invalid
   131 @publishedAll
       
   132 @released
       
   133 */
    93 */
   134 const TInt KEComErrReferenceCountInvalid			= -17013;
    94 const TInt KEComErrReferenceCountInvalid			= -17013;
   135 
    95 
   136 /** 
    96 /**
   137 The Interface Implementations destruction could not be recorded 
    97 The Interface Implementations destruction could not be recorded
   138 @publishedAll
       
   139 @released
       
   140 */
    98 */
   141 const TInt KEComErrDestructionFailed				= -17017;
    99 const TInt KEComErrDestructionFailed				= -17017;
   142 
   100 
   143 /** 
       
   144 An attempt has been made to update the registry information for a
       
   145 non-existent DLL.  An ECom internal error. 
       
   146 @publishedAll
       
   147 @released
       
   148 */
       
   149 const TInt KEComErrInvalidRegistryData				= -17022;
       
   150 
       
   151 /**
   101 /**
   152 The uid from a resource plugin does not match the uid from its
   102 The uid from a resource plugin does not match the uid from its
   153 corrsponding DLL. 
   103 corrsponding DLL.
   154 @publishedAll
       
   155 @released
       
   156 */
   104 */
   157 const TInt KEComErrMismatchedTags					= -17023;
   105 const TInt KEComErrMismatchedTags					= -17023;
   158 
   106 
   159 /**
   107 /**
   160 The scanning timer for re-discovering plugins is not found in the list
   108 The scanning timer for re-discovering plugins is not found in the list
   161 of scanning timers. 
   109 of scanning timers.
   162 @publishedAll
       
   163 @released
       
   164 */
   110 */
   165 const TInt KEComErrNotFoundScanTimer					= -17024;
   111 const TInt KEComErrNotFoundScanTimer					= -17033;
   166 /** 
   112 
       
   113 /**
   167 The client called DestroyedImplementation with a destruction
   114 The client called DestroyedImplementation with a destruction
   168 key of NULL.  This is an irrecoverable error because the object
   115 key of NULL.  This is an irrecoverable error because the object
   169 cannot be deleted. 
   116 cannot be deleted.
   170 @publishedAll
       
   171 @released
       
   172 */
   117 */
   173 const TInt KEComErrDestroyingWithNullDtorKey		= -17027;
   118 const TInt KEComErrDestroyingWithNullDtorKey		= -17027;
   174 
   119 
   175 
   120 //
   176 ////////////////////////////////////////////////////////////
       
   177 // Codes which are currently unused but reserved for future expansion
   121 // Codes which are currently unused but reserved for future expansion
   178 ////////////////////////////////////////////////////////////
   122 //
   179 /**
   123 /**
   180 @publishedAll
   124 The call to Enable the registered Interface Implementation failed
   181 @released
       
   182 */
       
   183 const TInt KEComErrAlreadyReceiving					= -17001;
       
   184 
       
   185 /** 
       
   186 The call to Enable the registered Interface Implementation failed 
       
   187 @publishedAll
       
   188 @released
       
   189 */
   125 */
   190 const TInt KEComErrEnableFailed						= -17005;
   126 const TInt KEComErrEnableFailed						= -17005;
   191 
   127 
   192 /** 
   128 /**
   193 The call to Disable the registered Interface Implementation failed 
   129 The call to Disable the registered Interface Implementation failed
   194 @publishedAll
       
   195 @released
       
   196 */
   130 */
   197 const TInt KEComErrDisableFailed					= -17006;
   131 const TInt KEComErrDisableFailed					= -17006;
   198 
   132 
   199 /** 
   133 /**
   200 The call to instantiate an Interface Implementation failed 
   134 The call to instantiate an Interface Implementation failed
   201 because no appropriate implementation was found. 
   135 because no appropriate implementation was found.
   202 @publishedAll
       
   203 @released
       
   204 */
   136 */
   205 const TInt KEComErrNoRegistrationsFound				= -17007;
   137 const TInt KEComErrNoRegistrationsFound				= -17007;
   206 
   138 
   207 /** 
   139 /**
   208 The call to Remove the registered Interface Implementation failed 
   140 The call to Remove the registered Interface Implementation failed
   209 @publishedAll
       
   210 @released
       
   211 */
   141 */
   212 const TInt KEComErrUninstallFailed					= -17009;
   142 const TInt KEComErrUninstallFailed					= -17009;
   213 
   143 
   214 /** 
   144 /**
   215 The call to Re-register an Interface Implementation failed 
   145 The call to Re-register an Interface Implementation failed
   216 @publishedAll
       
   217 @released
       
   218 */
   146 */
   219 const TInt KEComErrReinstallFailed					= -17010;
   147 const TInt KEComErrReinstallFailed					= -17010;
   220 
   148 
   221 /** 
   149 /**
   222 The call to Register an Interface Implementation failed 
   150 The call to Register an Interface Implementation failed
   223 @publishedAll
       
   224 @released
       
   225 */
   151 */
   226 const TInt KEComErrRegistrationFailed				= -17011;
   152 const TInt KEComErrRegistrationFailed				= -17011;
   227 
   153 
   228 /** 
   154 /**
   229 The client does not have a session open with the framework 
   155 The client does not have a session open with the framework
   230 @publishedAll
       
   231 @released
       
   232 */
   156 */
   233 const TInt KEComErrNotConnected						= -17012;
   157 const TInt KEComErrNotConnected						= -17012;
   234 
   158 
   235 /** 
   159 /**
   236 The call to Suspend registration activities failed 
   160 The call to Suspend registration activities failed
   237 @publishedAll
       
   238 @released
       
   239 */
   161 */
   240 const TInt KEComErrSuspendFailed					= -17015;
   162 const TInt KEComErrSuspendFailed					= -17015;
   241 
   163 
   242 /** 
   164 /**
   243 The call to Resume registration activities failed 
   165 The call to Resume registration activities failed
   244 @publishedAll
       
   245 @released
       
   246 */
   166 */
   247 const TInt KEComErrResumeFailed						= -17016;
   167 const TInt KEComErrResumeFailed						= -17016;
   248 
   168 
   249 /** 
   169 /**
   250 An attempt has been made to add a drive to the registry which
   170 An attempt has been made to add a drive to the registry which
   251 already exists 
   171 already exists
   252 @publishedAll
       
   253 @released
       
   254 */
   172 */
   255 const TInt KEComErrDriveAlreadyInstalled			= -17018;
   173 const TInt KEComErrDriveAlreadyInstalled			= -17018;
   256 
   174 
   257 /**
   175 /**
   258 @publishedAll
   176 An IIC has been found which does not have a corresponding
   259 @released
   177 registration information file
   260 */
       
   261 const TInt KEComErrIndexEntryNotFound				= -17020;
       
   262 
       
   263 /** 
       
   264 An IIC has been found which does not have a corresponding 
       
   265 registration information file 
       
   266 @publishedAll
       
   267 @released
       
   268 */
   178 */
   269 const TInt KEComErrNoRegistrationData				= -17021;
   179 const TInt KEComErrNoRegistrationData				= -17021;
   270 
   180 
   271 /**
       
   272 @publishedAll
       
   273 @released
       
   274 */
       
   275 const TInt KEComErrInstantiationPointerNotFound		= -17024;
       
   276 
   181 
   277 /**
       
   278 @publishedAll
       
   279 @released
       
   280 */
       
   281 const TInt KEComErrInstantiationPointerNotAvailable = -17025;
       
   282 
   182 
   283 #endif	// __ECOMERRORCODES_H__
   183 #endif	// __ECOMERRORCODES_H__