1 /*

     2 * Copyright (c) 2005-2007 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Virtual Phonebook framework error codes

    15 *

    16 */

    17 

    18 

    19 #ifndef VPBKERROR_H

    20 #define VPBKERROR_H

    21 

    22 

    23 // INCLUDES

    24 #include <e32std.h>

    25 

    26 

    27 /**

    28  * Virtual Phonebook Engine API error codes and functions.

    29  *

    30  * These codes are used in Virtual Phonebook APIs and all store plugin 

    31  * implementations must use them as documented in the API header files.

    32  * @lib VPbkEng.lib

    33  */

    34 namespace VPbkError

    35     {

    36     /// Panic category for Virtual Phonebook APIs.

    37     _LIT(KPanicCategory, "VPbkEng");

    38 

    39     /**

    40      * Panic codes for the Virtual Phonebook APIs.

    41      */

    42     enum TPanicCode

    43         {

    44         /// Invalid index was used

    45         EInvalidTypeParameter = 1,

    46         EInvalidTypeParameterResource,

    47         EFieldDataTypeMismatch,

    48         EInvalidFieldIndex,

    49         ENullContactField,

    50         EInvalidContactField,

    51         EInvalidContactIndex,

    52         EInvalidStoreIndex,

    53         EInvalidLength,

    54         EInvalidAccessToReadOnlyContact,

    55         EInvalidLinkArrayVersion,

    56         EAccessOfUnopenedStore

    57         };

    58 

    59     /**

    60      * Called if an unrecoverable error is detected.

    61      *

    62      * Stops the thread with User::Panic.

    63      *

    64      * @param aPanicCode One of the TPanicCode values.

    65      */

    66     IMPORT_C void Panic(TPanicCode aPanicCode);

    67     }

    68 

    69 

    70 #endif  // VPBKERROR_H