epoc32/include/pcstore/storeexception.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
// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
//
williamr@4
    15
williamr@4
    16
#if !defined(__STOREEXCEPTION_H__)
williamr@4
    17
#define __STOREEXCEPTION_H__
williamr@4
    18
williamr@4
    19
namespace PCStore
williamr@4
    20
{
williamr@4
    21
/**
williamr@4
    22
@internalAll
williamr@4
    23
williamr@4
    24
Class for the exceptions which will be thrown by the PCStore library.
williamr@4
    25
*/
williamr@4
    26
class TStoreException
williamr@4
    27
	{
williamr@4
    28
public:
williamr@4
    29
	//Enumerations for the store open mode
williamr@4
    30
	enum EStoreError
williamr@4
    31
		{
williamr@4
    32
		/**
williamr@4
    33
		library wide error code -1: fail to open file.
williamr@4
    34
		*/
williamr@4
    35
		EFileOpenError = -1,
williamr@4
    36
williamr@4
    37
		/**
williamr@4
    38
		library wide error code -2: fail to read file.
williamr@4
    39
		*/
williamr@4
    40
		EFileReadError = -2,
williamr@4
    41
williamr@4
    42
		/**
williamr@4
    43
		library wide error code -3: fail to write file.
williamr@4
    44
		*/
williamr@4
    45
		EFileWriteError = -3,
williamr@4
    46
williamr@4
    47
		/**
williamr@4
    48
		library wide error code -4: fail to seek file.
williamr@4
    49
		*/
williamr@4
    50
		EFileSeekError = -4,
williamr@4
    51
williamr@4
    52
		/**
williamr@4
    53
		library wide error code -5: attemp to create stream while another stream exists.
williamr@4
    54
		*/
williamr@4
    55
		EStreamExclusionError = -5,
williamr@4
    56
williamr@4
    57
		/**
williamr@4
    58
		library wide error code -6: the file is not the supported store type.
williamr@4
    59
		*/
williamr@4
    60
		EStoreNotSupported = -6,
williamr@4
    61
williamr@4
    62
		/**
williamr@4
    63
		library wide error code -7: operation on a mismatching type of store.
williamr@4
    64
		*/
williamr@4
    65
		EStoreModeError = -7,
williamr@4
    66
williamr@4
    67
		/**
williamr@4
    68
		library wide error code -8: the store file is corrupted.
williamr@4
    69
		*/
williamr@4
    70
		EStoreCorrupt = -8,
williamr@4
    71
williamr@4
    72
		/**
williamr@4
    73
		library wide error code -9: the maximum length of the descriptor overfloates
williamr@4
    74
		*/
williamr@4
    75
		EDesOverfloat = -9
williamr@4
    76
		};
williamr@4
    77
	TStoreException(EStoreError aCode);
williamr@4
    78
williamr@4
    79
public:
williamr@4
    80
	EStoreError iErrorCode;
williamr@4
    81
	};
williamr@4
    82
}
williamr@4
    83
#endif // !defined(__STOREEXCEPTION_H__)