persistentstorage/sql/SRC/Common/SqlPanic.h
author Pat Downey <patd@symbian.org>
Wed, 01 Sep 2010 12:39:58 +0100
branchRCL_3
changeset 24 cc28652e0254
parent 23 26645d81f48d
permissions -rw-r--r--
Revert incorrect RCL_3 drop: Revision: 201035 Kit: 201035
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
0
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     2
// All rights reserved.
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     3
// This component and the accompanying materials are made available
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     5
// which accompanies this distribution, and is available
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     7
//
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     8
// Initial Contributors:
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    10
//
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    11
// Contributors:
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    12
//
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    13
// Description:
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    14
//
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    15
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    16
#ifndef __SQLPANIC_H__
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    17
#define __SQLPANIC_H__
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    18
24
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    19
#include "SqlAssert.h"
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    20
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    21
//Forward declarations
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    22
class RMessage2;
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    23
0
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    24
/**
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    25
TSqlPanic contains panic codes which may used by the SQL component (SqlDb.dll and SqlSrv.exe).
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    26
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    27
@publishedAll
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    28
@released
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    29
*/
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    30
enum TSqlPanic
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    31
	{
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    32
	ESqlPanicObjExists 			=   1,
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    33
	ESqlPanicInvalidObj			=   2,
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    34
	ESqlPanicBadHandle 			=   3,		
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    35
	ESqlPanicBadArgument 		=   4,		
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    36
	ESqlPanicBadColumnIndex 	=   5,
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    37
	ESqlPanicTypeMismatch 		=   6,	
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    38
	ESqlPanicInternalError		=   7,
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    39
	ESqlPanicStreamMarkInvalid  =   8,
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    40
	ESqlPanicStreamLocationInvalid= 9,
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    41
	ESqlPanicValueNotPresent  	=  10,
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    42
	ESqlPanicInvalidRow			=  11,
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    43
	ESqlPanicMisuse				=  12,
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    44
	ESqlPanicBadDescriptor		=  13
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    45
	};
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    46
24
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    47
/**
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    48
This function panics the thread where it is called from with aPanicCode panic code.
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    49
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    50
@param aPanicCode Panic code
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    51
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    52
@internalComponent
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    53
*/
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    54
void SqlPanic(TSqlPanic aPanicCode);
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    55
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    56
/**
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    57
This function is used inside the SQL server to panic the calling client.
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    58
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    59
@param aMessage The message which processing causes the panic.
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    60
@param aPanicCode Panic code
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    61
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    62
@leave KSqlLeavePanic
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    63
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    64
@return KErrNone
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    65
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    66
@internalComponent
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    67
*/
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    68
TInt SqlPanicClientL(const RMessage2& aMessage, TSqlPanic aPanicCode);
cc28652e0254 Revert incorrect RCL_3 drop:
Pat Downey <patd@symbian.org>
parents: 23
diff changeset
    69
	
0
08ec8eefde2f Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    70
#endif //__SQLPANIC_H__