epoc32/include/caf/caferr.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2003-2006 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
/** 
williamr@2
    21
@file
williamr@2
    22
williamr@2
    23
This contains error code definitions required by clients accessing the 
williamr@2
    24
Content Access Framework.
williamr@2
    25
williamr@2
    26
All CAF error codes lie within the range \c KErrCA_LowerLimit to 
williamr@2
    27
\c KErrCA_UpperLimit inclusive.
williamr@2
    28
williamr@2
    29
@publishedPartner
williamr@2
    30
@released
williamr@2
    31
*/
williamr@2
    32
williamr@2
    33
williamr@2
    34
williamr@2
    35
#ifndef __CAFERR_H__
williamr@2
    36
#define __CAFERR_H__
williamr@2
    37
williamr@2
    38
#include <e32std.h>
williamr@2
    39
williamr@2
    40
williamr@2
    41
/**
williamr@2
    42
This is the upper limit of the CAF error code range.
williamr@2
    43
williamr@2
    44
Example usage:
williamr@2
    45
@code
williamr@2
    46
if (KErrCA_LowerLimit <= err && err <= KErrCA_UpperLimit)
williamr@2
    47
	{
williamr@2
    48
	// handle CAF-specific error
williamr@2
    49
	}
williamr@2
    50
@endcode
williamr@2
    51
*/
williamr@2
    52
const TInt KErrCA_UpperLimit = -17450;
williamr@2
    53
williamr@2
    54
williamr@2
    55
/**
williamr@2
    56
This is the lower limit of the CAF error code range.
williamr@2
    57
williamr@2
    58
Example usage:
williamr@2
    59
@code
williamr@2
    60
if (KErrCA_LowerLimit <= err && err <= KErrCA_UpperLimit)
williamr@2
    61
	{
williamr@2
    62
	// handle CAF-specific error
williamr@2
    63
	}
williamr@2
    64
@endcode
williamr@2
    65
*/
williamr@2
    66
const TInt KErrCA_LowerLimit = -17549;
williamr@2
    67
williamr@2
    68
williamr@2
    69
williamr@2
    70
/**
williamr@2
    71
Agent does not support the requested capability.
williamr@2
    72
*/
williamr@2
    73
const TInt KErrCANotSupported = -17450;
williamr@2
    74
williamr@2
    75
/** 
williamr@2
    76
Rights evaluation failed for the supplied intent. This implies that
williamr@2
    77
rights were available, but their evaluation, in the context of
williamr@2
    78
supplied intent, failed.
williamr@2
    79
*/
williamr@2
    80
const TInt KErrCANoPermission = -17451; 
williamr@2
    81
williamr@2
    82
/** 
williamr@2
    83
No rights were available for evaluation. A number of causes may
williamr@2
    84
generate this error: Perhaps the rights were removed or lost
williamr@2
    85
during a separate delivery
williamr@2
    86
*/
williamr@2
    87
const TInt KErrCANoRights = -17452; 
williamr@2
    88
williamr@2
    89
/**
williamr@2
    90
The Agent required is not present. This may occur if content
williamr@2
    91
'belongs' to an agent that is no longer available on the 
williamr@2
    92
device. 
williamr@2
    93
*/
williamr@2
    94
const TInt KErrCANoAgent = -17453;
williamr@2
    95
williamr@2
    96
/**
williamr@2
    97
Values specified are out of range. 
williamr@2
    98
*/
williamr@2
    99
const TInt KErrCAOutOfRange = -17454;
williamr@2
   100
williamr@2
   101
/** 
williamr@2
   102
The rights were not available but are 'expected'. Will only be
williamr@2
   103
returned if the agent supports this capability. 
williamr@2
   104
*/
williamr@2
   105
const TInt KErrCAPendingRights = -17455;
williamr@2
   106
williamr@2
   107
/**
williamr@2
   108
A request to get the content size failed because the agent was unable
williamr@2
   109
to determine it. This error may occur on circumstances where, say, the
williamr@2
   110
content is streamed over HTTP.
williamr@2
   111
*/
williamr@2
   112
const TInt KErrCASizeNotDetermined = -17456;
williamr@2
   113
williamr@2
   114
/**
williamr@2
   115
The function failed because the agent needs the client to provide another
williamr@2
   116
file handle before the import can continue
williamr@2
   117
*/
williamr@2
   118
const TInt KErrCANewFileHandleRequired = -17457;
williamr@2
   119
williamr@2
   120
williamr@2
   121
/**
williamr@2
   122
The rights object failed an integrity check.
williamr@2
   123
williamr@2
   124
This error is returned when a client attempts an operation which requires 
williamr@2
   125
accessing a rights object.
williamr@2
   126
williamr@2
   127
*/ 
williamr@2
   128
const TInt KErrCACorruptRights = -17458;
williamr@2
   129
williamr@2
   130
williamr@2
   131
/**
williamr@2
   132
The content object failed an integrity check.
williamr@2
   133
williamr@2
   134
This error is returned when a client attempts an operation which requires 
williamr@2
   135
accessing a content object.
williamr@2
   136
williamr@2
   137
*/ 
williamr@2
   138
const TInt KErrCACorruptContent = -17459;
williamr@2
   139
williamr@2
   140
williamr@2
   141
#endif // __CAFERR_H__