epoc32/include/lbserrors.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
equal deleted inserted replaced
1:666f914201fb 2:2fe1408b6811
     1 lbserrors.h
     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 __LBSERRORS_H__
       
    17 #define __LBSERRORS_H__
       
    18 
       
    19 #include <e32def.h>
       
    20 #include <lbs/lbsvariant.h>
       
    21 
       
    22 /**
       
    23 LBS Panic string
       
    24 
       
    25 @publishedAll
       
    26 @released
       
    27  */
       
    28 _LIT(KPosClientFault,"Lbs Client Fault");
       
    29 
       
    30 /**
       
    31 Position Client API panic codes
       
    32 
       
    33 @publishedAll
       
    34 @released
       
    35  */
       
    36 enum TPositionClientPanic
       
    37 	{
       
    38 	/** HPGI datatype mismatch */
       
    39 	EPositionGenericInfoMismatchDataType		= 0,
       
    40 	/** CRequestor constructed with a null descriptor */
       
    41 	EPositionRequestorConstructorGivenNullData	= 1,
       
    42 	/** HPGI zero-byte buffer */
       
    43 	EPositionGenericInfoZeroBufferSize			= 2,
       
    44 	/** A unknown IPC request has been made on the server. */
       
    45 	EPositionBadRequest							= 3,
       
    46 	/** A bad descriptor has been given to the server by the client. */
       
    47 	EPositionBadDescriptor						= 4,
       
    48 	/** An attempt has been made to connect using an already open handle. */
       
    49 	EPositionServerHandleNotClosed				= 5,
       
    50 	/** An attempt has been made to communicate though a non connected handle. */
       
    51 	EPositionServerBadHandle					= 6,
       
    52 	/** A client has tried to use a RPositioner/RPositionServer handle that hasn't
       
    53 	    been properly initialised. */
       
    54 	EPositionNullPointerHolder					= 7,
       
    55 	/** A client has asked for/set the supported classes in TPositionModuleInfo
       
    56 	    with an invalid class type. */
       
    57 	EPositionInvalidClassType					= 8,
       
    58 	/** Too many items specified in a TPositionSelectionOrder. */
       
    59 	EPositionSelectionOrderOverflow				= 9,
       
    60 	/** The class' size doesn't match the expected value. */
       
    61 	EPositionClassSizeMismatch					= 10,
       
    62 	/** An unsupported object of size greater than KPositionMaxSizeQualityTrait has been
       
    63 	passed to a TPositionQualityBase as a field. */
       
    64 	EPositionQualityBadDataType					= 11,
       
    65 	/** A negative TTimeIntervalMicroSeconds was passed to a method. */
       
    66 	EPositionBadTime                            = 12,
       
    67 	/** A negative value for accuracy was passed to a method. */
       
    68 	EPositionBadAccuracy                        = 13,
       
    69 	/** A client has attempted to instantiate a HPositionGenricInfo with 0 Max Fields. */
       
    70 	EPositionGenericInfoZeroMaxFields			= 14,
       
    71 	/** A client has called an asynchronous request while it is still outstanding
       
    72 	on that RPositionServer / RPositioner. */
       
    73 	EPositionDuplicateRequest                   = 15,
       
    74 	/** A session or sub-session was closed with requests still outstanding. */
       
    75 	EPositionRequestsNotCancelled               = 16,
       
    76 	/** A NULL entry has been found in the requestor stack. */
       
    77 	EPositionNullRequestor	                    = 17
       
    78 	};
       
    79 
       
    80 
       
    81 /**
       
    82 Completion codes to give extended information about location fix.
       
    83 
       
    84 @publishedAll
       
    85 @released
       
    86  */
       
    87 const TInt KPositionQualityLoss = 1;
       
    88 
       
    89 /**
       
    90 Completion code for partial update.
       
    91 
       
    92 @publishedAll
       
    93 @released
       
    94  */
       
    95 const TInt KPositionPartialUpdate = 2;
       
    96 
       
    97 /**
       
    98 Completion code indicating that the request has returned early at the explicit request of the application.
       
    99 @see RPositionerSubSessionBase::CompleteRequest()
       
   100 
       
   101 @publishedAll
       
   102 @released
       
   103  */
       
   104 const TInt KPositionEarlyComplete = 3;
       
   105 
       
   106 /**
       
   107 Status code indicating that a location data source has determined it will be unable to
       
   108 provide an update of the required quality. This is only reported by the data source 
       
   109 module when it has reasoned that there is no point in continuing with the calculation.
       
   110 It is not reported when there are transient conditions that might prevent the module
       
   111 from obtaining the desired location information.
       
   112 
       
   113 @publishedAll
       
   114 @released
       
   115  */
       
   116 const TInt KPositionCalculationFutile = 4;
       
   117 
       
   118 
       
   119 /**
       
   120 Code indicating that the assistance data response asks for a reset of the assistance data, as 
       
   121 shown by the data mask.
       
   122 
       
   123 @publishedPartner
       
   124 @prototype
       
   125  */
       
   126 const TInt KPositionAssistanceDataReset = 5;
       
   127 
       
   128 /**
       
   129 Lbs specific error codes.
       
   130 
       
   131 @publishedAll
       
   132 @released
       
   133 
       
   134 If __S60_ is defined in lbsvariant.h the constant is -30371 otherwise it is -17350
       
   135  */
       
   136 const TInt KPositionErrBase = __LBS_TDEFAULT_ERROR_BASE;
       
   137 
       
   138 /**
       
   139 BufferOverflow error
       
   140 
       
   141 @publishedAll
       
   142 @released
       
   143  */
       
   144 const TInt KErrPositionBufferOverflow = KPositionErrBase;
       
   145 
       
   146 /**
       
   147 Position  calculation error
       
   148 
       
   149 @publishedAll
       
   150 @released
       
   151  */
       
   152 const TInt KErrPositionIncalculable = KPositionErrBase - 1;
       
   153 
       
   154 /**
       
   155 Network error
       
   156 
       
   157 @publishedAll
       
   158 @released
       
   159  */
       
   160 const TInt KPositionNetworkErrorBase = -18301;
       
   161 
       
   162 /**
       
   163 Returned by the network, when it cannot perform an operation due to a failure in the network
       
   164 
       
   165 @publishedAll
       
   166 @released
       
   167  */
       
   168 const TInt KErrPositionSystemFailure				= KPositionNetworkErrorBase - 0; //-18301
       
   169 
       
   170 /**
       
   171 Returned due to an protocol related error.
       
   172 
       
   173 @publishedAll
       
   174 @released
       
   175  */
       
   176 const TInt KErrPositionProtocolErr					= KPositionNetworkErrorBase - 1; //-18302
       
   177 
       
   178 /**
       
   179 @publishedAll
       
   180 @released
       
   181 Returned by the network when the network is unable
       
   182 (a) To obtain the requested location information or
       
   183 (b) The desired QoS could not be satisfied or
       
   184 (c) The requested LCS assistance data could not be delivered or
       
   185 (d) The requested deciphering keys for broadcast assistance data could not be returned.
       
   186  */
       
   187 const TInt KErrPositionMethodFailure				= KPositionNetworkErrorBase - 2; //-18303
       
   188 
       
   189 /**
       
   190 Returned by the network receiving a request about a facility which is not supported in the PLMN.
       
   191 
       
   192 @publishedAll
       
   193 @released
       
   194 */
       
   195 const TInt KErrPositionFacilityNoSupport			= KPositionNetworkErrorBase - 3; //-18304
       
   196 
       
   197 /**
       
   198 @publishedAll
       
   199 @released
       
   200 Returned by the network when it is requested to perform an operation on a supplementary
       
   201 service that violated the subscription restrictions.
       
   202 The nature of the restriction or the transgressed options may be sent as parameters.
       
   203  */
       
   204 const TInt KErrPositionNoService						= KPositionNetworkErrorBase - 4; //-18305
       
   205 
       
   206 /**
       
   207 @publishedAll
       
   208 @released
       
   209 Returned by the network when authorization failed for a informed LCSClientID. 
       
   210  */
       
   211 const TInt KErrPositionUnauthorizedLCSClient		= KPositionNetworkErrorBase - 5; //-18306
       
   212 
       
   213 /**
       
   214 @publishedAll
       
   215 @released
       
   216 Returned by the network when an informed LCSClient is not available.
       
   217  */
       
   218 const TInt KErrPositionServiceNotSubscribed		= KPositionNetworkErrorBase - 6; //-18307
       
   219 
       
   220 /**
       
   221 @publishedAll
       
   222 @released
       
   223 Returned when a requests is cancelled due to receiving higher priority request.
       
   224  */
       
   225 const TInt KErrPositionHighPriorityReceive		= KPositionNetworkErrorBase - 7; //-18308
       
   226 
       
   227 
       
   228 /**
       
   229 Indicates an error due to no network coverage.
       
   230 
       
   231 @publishedAll
       
   232 @prototype
       
   233  */
       
   234 const TInt KErrPositionNetworkUnavailable					= KPositionNetworkErrorBase - 8; //-18309
       
   235 
       
   236 
       
   237 /**
       
   238 Data source errors
       
   239 
       
   240 @publishedAll
       
   241 @released
       
   242  */
       
   243 const TInt KPositionDataSourceErrorBase = -18350;
       
   244 
       
   245 
       
   246 #endif //__LBSERRORS_H__