1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/VPbkError.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,70 @@
     1.4 +/*
     1.5 +* Copyright (c) 2005-2007 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  Virtual Phonebook framework error codes
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef VPBKERROR_H
    1.23 +#define VPBKERROR_H
    1.24 +
    1.25 +
    1.26 +// INCLUDES
    1.27 +#include <e32std.h>
    1.28 +
    1.29 +
    1.30 +/**
    1.31 + * Virtual Phonebook Engine API error codes and functions.
    1.32 + *
    1.33 + * These codes are used in Virtual Phonebook APIs and all store plugin 
    1.34 + * implementations must use them as documented in the API header files.
    1.35 + * @lib VPbkEng.lib
    1.36 + */
    1.37 +namespace VPbkError
    1.38 +    {
    1.39 +    /// Panic category for Virtual Phonebook APIs.
    1.40 +    _LIT(KPanicCategory, "VPbkEng");
    1.41 +
    1.42 +    /**
    1.43 +     * Panic codes for the Virtual Phonebook APIs.
    1.44 +     */
    1.45 +    enum TPanicCode
    1.46 +        {
    1.47 +        /// Invalid index was used
    1.48 +        EInvalidTypeParameter = 1,
    1.49 +        EInvalidTypeParameterResource,
    1.50 +        EFieldDataTypeMismatch,
    1.51 +        EInvalidFieldIndex,
    1.52 +        ENullContactField,
    1.53 +        EInvalidContactField,
    1.54 +        EInvalidContactIndex,
    1.55 +        EInvalidStoreIndex,
    1.56 +        EInvalidLength,
    1.57 +        EInvalidAccessToReadOnlyContact,
    1.58 +        EInvalidLinkArrayVersion,
    1.59 +        EAccessOfUnopenedStore
    1.60 +        };
    1.61 +
    1.62 +    /**
    1.63 +     * Called if an unrecoverable error is detected.
    1.64 +     *
    1.65 +     * Stops the thread with User::Panic.
    1.66 +     *
    1.67 +     * @param aPanicCode One of the TPanicCode values.
    1.68 +     */
    1.69 +    IMPORT_C void Panic(TPanicCode aPanicCode);
    1.70 +    }
    1.71 +
    1.72 +
    1.73 +#endif  // VPBKERROR_H