williamr@4: /*
williamr@4: * Copyright (c) 2005-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@4: * All rights reserved.
williamr@4: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@4: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4: *
williamr@4: * Initial Contributors:
williamr@4: * Nokia Corporation - initial contribution.
williamr@4: *
williamr@4: * Contributors:
williamr@4: *
williamr@4: * Description:  Virtual Phonebook framework error codes
williamr@4: *
williamr@4: */
williamr@4: 
williamr@4: 
williamr@4: #ifndef VPBKERROR_H
williamr@4: #define VPBKERROR_H
williamr@4: 
williamr@4: 
williamr@4: // INCLUDES
williamr@4: #include <e32std.h>
williamr@4: 
williamr@4: 
williamr@4: /**
williamr@4:  * Virtual Phonebook Engine API error codes and functions.
williamr@4:  *
williamr@4:  * These codes are used in Virtual Phonebook APIs and all store plugin 
williamr@4:  * implementations must use them as documented in the API header files.
williamr@4:  * @lib VPbkEng.lib
williamr@4:  */
williamr@4: namespace VPbkError
williamr@4:     {
williamr@4:     /// Panic category for Virtual Phonebook APIs.
williamr@4:     _LIT(KPanicCategory, "VPbkEng");
williamr@4: 
williamr@4:     /**
williamr@4:      * Panic codes for the Virtual Phonebook APIs.
williamr@4:      */
williamr@4:     enum TPanicCode
williamr@4:         {
williamr@4:         /// Invalid index was used
williamr@4:         EInvalidTypeParameter = 1,
williamr@4:         EInvalidTypeParameterResource,
williamr@4:         EFieldDataTypeMismatch,
williamr@4:         EInvalidFieldIndex,
williamr@4:         ENullContactField,
williamr@4:         EInvalidContactField,
williamr@4:         EInvalidContactIndex,
williamr@4:         EInvalidStoreIndex,
williamr@4:         EInvalidLength,
williamr@4:         EInvalidAccessToReadOnlyContact,
williamr@4:         EInvalidLinkArrayVersion,
williamr@4:         EAccessOfUnopenedStore
williamr@4:         };
williamr@4: 
williamr@4:     /**
williamr@4:      * Called if an unrecoverable error is detected.
williamr@4:      *
williamr@4:      * Stops the thread with User::Panic.
williamr@4:      *
williamr@4:      * @param aPanicCode One of the TPanicCode values.
williamr@4:      */
williamr@4:     IMPORT_C void Panic(TPanicCode aPanicCode);
williamr@4:     }
williamr@4: 
williamr@4: 
williamr@4: #endif  // VPBKERROR_H