epoc32/include/authserver/auth_srv_errs.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
/*
williamr@4
     2
* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description: 
williamr@4
    15
* Contains the list of error values that may be returned. 
williamr@4
    16
*
williamr@4
    17
*/
williamr@4
    18
williamr@4
    19
williamr@4
    20
/**
williamr@4
    21
 @file 
williamr@4
    22
 @publishedAll
williamr@4
    23
 @released
williamr@4
    24
*/
williamr@4
    25
williamr@4
    26
#ifndef AUTH_SRV_ERRS_H
williamr@4
    27
#define AUTH_SRV_ERRS_H
williamr@4
    28
williamr@4
    29
#include <e32def.h>
williamr@4
    30
williamr@4
    31
/**
williamr@4
    32
	Attempted to internalize an invalid authentication expression stream.
williamr@4
    33
	
williamr@4
    34
	If this error occurs on the server side because the client
williamr@4
    35
	has sent an invalid externalization buffer they are panicked
williamr@4
    36
	with "AUTHSERVER 3", instead of being completed with this
williamr@4
    37
	error code.
williamr@4
    38
williamr@4
    39
	This error should not occur if clients use the supplied
williamr@4
    40
	RAuthClient API.
williamr@4
    41
 */
williamr@4
    42
const TInt KErrAuthServInvalidInternalizeExpr = -10800;
williamr@4
    43
williamr@4
    44
/**
williamr@4
    45
	Attempted to internalize an authentication expression stream
williamr@4
    46
	with an unsupported version.
williamr@4
    47
	
williamr@4
    48
	The authentication server will complete an authentication
williamr@4
    49
	request with this value if the supplied stream has an
williamr@4
    50
	unsupported version number.
williamr@4
    51
williamr@4
    52
	This error code is rare and is caused by sending a corrupt
williamr@4
    53
	externalized expression to the server, or if the expression
williamr@4
    54
	was internalized with an older version of the client code.
williamr@4
    55
	This error should not occur if clients use the supplied
williamr@4
    56
	RAuthClient API.
williamr@4
    57
 */
williamr@4
    58
const TInt KErrAuthServUnsupportedExprVersion = -10801;
williamr@4
    59
williamr@4
    60
/**
williamr@4
    61
    An attempt was made to reference a plugin by id number and no such 
williamr@4
    62
    plugin exists  
williamr@4
    63
 **/
williamr@4
    64
const TInt KErrAuthServNoSuchPlugin = -10802;
williamr@4
    65
williamr@4
    66
williamr@4
    67
/**
williamr@4
    68
    An attempt was made to reference an identity by id number and no such 
williamr@4
    69
    identity exists  
williamr@4
    70
 **/
williamr@4
    71
const TInt KErrAuthServNoSuchIdentity = -10803;
williamr@4
    72
williamr@4
    73
/**
williamr@4
    74
    A plugin returns this on behalf of a user wanting to skip it.
williamr@4
    75
 **/
williamr@4
    76
const TInt KErrAuthServPluginCancelled = -10804;
williamr@4
    77
williamr@4
    78
/**
williamr@4
    79
    A plugin returns this on behalf of a user wanting to completely quit the
williamr@4
    80
    current operation.
williamr@4
    81
 **/
williamr@4
    82
const TInt KErrAuthServPluginQuit = -10805;
williamr@4
    83
williamr@4
    84
williamr@4
    85
/**
williamr@4
    86
    This error is reported when an operation is attempted for which an
williamr@4
    87
    authentication must have already been performed.
williamr@4
    88
 **/
williamr@4
    89
const TInt KErrAuthServAuthenticationRequired = -10806;
williamr@4
    90
williamr@4
    91
/**
williamr@4
    92
	Attempted to add a new identity to the authentication
williamr@4
    93
	server database with an existing ID.
williamr@4
    94
 */
williamr@4
    95
const TInt KErrAuthServIdentityAlreadyExists = -10807;
williamr@4
    96
williamr@4
    97
/**
williamr@4
    98
	Attempted to set or retrieve a description for an identity,
williamr@4
    99
	or remove an identity which was not in the authentication database.
williamr@4
   100
 */
williamr@4
   101
const TInt KErrAuthServIdentityNotFound = -10808;
williamr@4
   102
williamr@4
   103
/**
williamr@4
   104
	Attempted to remove or retrieve the key info for
williamr@4
   105
	a training record that was not in the authentication
williamr@4
   106
	database.
williamr@4
   107
 */
williamr@4
   108
const TInt KErrAuthServTrainingNotFound = -10809;
williamr@4
   109
williamr@4
   110
/**
williamr@4
   111
    This error is reported when the authserver has not been able to register a
williamr@4
   112
    new identity due to no plugins training successfully.
williamr@4
   113
 **/
williamr@4
   114
const TInt KErrAuthServRegistrationFailed = -10810;
williamr@4
   115
williamr@4
   116
williamr@4
   117
/**
williamr@4
   118
    This error is reported when an authclient attempts to remove the last
williamr@4
   119
    identity.
williamr@4
   120
 **/
williamr@4
   121
const TInt KErrAuthServCanNotRemoveLastIdentity = -10811;
williamr@4
   122
williamr@4
   123
williamr@4
   124
/**
williamr@4
   125
    This error is reported when an authclient attempts to remove the last
williamr@4
   126
    trained plugin for an identity.
williamr@4
   127
 **/
williamr@4
   128
const TInt KErrAuthServCanNotRemoveLastPlugin = -10812;
williamr@4
   129
williamr@4
   130
williamr@4
   131
/**
williamr@4
   132
    This error is reported when an attempt to use an inactive plugin is made.
williamr@4
   133
 **/
williamr@4
   134
const TInt KErrAuthServPluginNotActive = -10813;
williamr@4
   135
williamr@4
   136
/**
williamr@4
   137
	Client attempted to create an identity with a description
williamr@4
   138
	longer than 255 characters, or to change an existing identity's
williamr@4
   139
	description to use more than 255 characters.
williamr@4
   140
 */
williamr@4
   141
const TInt KErrAuthServDescTooLong = -10814;
williamr@4
   142
williamr@4
   143
/**
williamr@4
   144
	This error is reported when the authentication strength alias
williamr@4
   145
	supplied by the client is not found in the authserver's
williamr@4
   146
	central repository file.
williamr@4
   147
 */
williamr@4
   148
williamr@4
   149
const TInt KErrUnknownAuthStrengthAlias = -10815;
williamr@4
   150
williamr@4
   151
/**
williamr@4
   152
	This error is reported when an authentication strength in 
williamr@4
   153
	the authserver's central repository file is undefined.
williamr@4
   154
 */
williamr@4
   155
williamr@4
   156
const TInt KErrAuthStrengthAliasNotDefined = -10816;
williamr@4
   157
williamr@4
   158
/**
williamr@4
   159
	This error is reported when an alias string defining an
williamr@4
   160
	authentication strength in the authserver's central repository 
williamr@4
   161
	file contains expression other than plugin Id, plugin Types 
williamr@4
   162
	and operators ("& and "|").
williamr@4
   163
 */
williamr@4
   164
williamr@4
   165
const TInt KErrAuthServInvalidAliasStringExpression = -10817;
williamr@4
   166
williamr@4
   167
williamr@4
   168
/**
williamr@4
   169
    This error is reported when an authclient attempts to remove the default
williamr@4
   170
    identity.
williamr@4
   171
 */
williamr@4
   172
const TInt KErrAuthServCanNotRemoveDefaultIdentity = KErrAuthServCanNotRemoveLastIdentity;
williamr@4
   173
williamr@4
   174
/**
williamr@4
   175
    This error is reported when an authentication manager client attempts to 
williamr@4
   176
    reset an identity and this may result in zero plugins registering the new identity data.
williamr@4
   177
    This can happen if a reset request is issued for all plugins registered for an identity 
williamr@4
   178
    and none of the plugins are of knowledge type.
williamr@4
   179
 */
williamr@4
   180
const TInt KErrAuthServResetMayLoseIdentity = -10818;
williamr@4
   181
williamr@4
   182
#endif	// #ifndef AUTH_SRV_ERRS_H
williamr@4
   183