58
|
1 |
/*
|
|
2 |
* Copyright (c) 2010 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: CSifUiErrorInfo for installation error details
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
#ifndef C_SIFUIERRORINFO_H
|
|
19 |
#define C_SIFUIERRORINFO_H
|
|
20 |
|
|
21 |
#include <e32base.h> // CBase
|
|
22 |
#include <usif/usiferror.h> // Usif::TErrorCategory
|
|
23 |
|
|
24 |
|
|
25 |
/**
|
|
26 |
* CSifUiErrorInfo is a container class for installation error details.
|
|
27 |
*
|
|
28 |
* @lib sifui.lib
|
|
29 |
* @since 10.1
|
|
30 |
*/
|
|
31 |
class CSifUiErrorInfo : public CBase
|
|
32 |
{
|
|
33 |
public: // constructors and destructor
|
|
34 |
/**
|
|
35 |
* Creates new CSifUiErrorInfo object and pushes it to cleanup stack.
|
|
36 |
* @param aErrorCategory - error category
|
|
37 |
* @param aErrorCode - error code
|
|
38 |
* @param aExtendedErrorCode - extended error code
|
|
39 |
* @param aErrorMessage - error message
|
|
40 |
* @param aErrorMessageDetails - detailed error message
|
|
41 |
* @returns CSifUiErrorInfo* -- new CSifUiErrorInfo object
|
|
42 |
*/
|
|
43 |
IMPORT_C static CSifUiErrorInfo* NewLC( Usif::TErrorCategory aErrorCategory,
|
|
44 |
TInt aErrorCode, TInt aExtendedErrorCode,
|
|
45 |
const TDesC& aErrorMessage, const TDesC& aErrorMessageDetails );
|
|
46 |
|
|
47 |
/**
|
|
48 |
* Creates new CSifUiErrorInfo object.
|
|
49 |
* @param aErrorCategory - error category
|
|
50 |
* @param aErrorCode - error code
|
|
51 |
* @param aExtendedErrorCode - extended error code
|
|
52 |
* @param aErrorMessage - error message
|
|
53 |
* @param aErrorMessageDetails - detailed error message
|
|
54 |
* @returns CSifUiErrorInfo* -- new CSifUiErrorInfo object
|
|
55 |
*/
|
|
56 |
IMPORT_C static CSifUiErrorInfo* NewL( Usif::TErrorCategory aErrorCategory,
|
|
57 |
TInt aErrorCode, TInt aExtendedErrorCode,
|
|
58 |
const TDesC& aErrorMessage, const TDesC& aErrorMessageDetails );
|
|
59 |
|
|
60 |
/**
|
|
61 |
* Destructor.
|
|
62 |
*/
|
|
63 |
~CSifUiErrorInfo();
|
|
64 |
|
|
65 |
public: // new functions
|
|
66 |
|
|
67 |
/**
|
|
68 |
* Error category.
|
|
69 |
* @returns Usif::TErrorCategory - error category
|
|
70 |
*/
|
|
71 |
inline Usif::TErrorCategory ErrorCategory() const;
|
|
72 |
|
|
73 |
/**
|
|
74 |
* Error code.
|
|
75 |
* @returns TInt - error code
|
|
76 |
*/
|
|
77 |
inline TInt ErrorCode() const;
|
|
78 |
|
|
79 |
/**
|
|
80 |
* Extended error code.
|
|
81 |
* @returns TInt - extended error code
|
|
82 |
*/
|
|
83 |
inline TInt ExtendedErrorCode() const;
|
|
84 |
|
|
85 |
/**
|
|
86 |
* Error message.
|
|
87 |
* @returns const TDesC& - error message
|
|
88 |
*/
|
|
89 |
inline const TDesC& ErrorMessage() const;
|
|
90 |
|
|
91 |
/**
|
|
92 |
* Error message details.
|
|
93 |
* @returns const TDesC& - additional error message details
|
|
94 |
*/
|
|
95 |
inline const TDesC& ErrorMessageDetails() const;
|
|
96 |
|
|
97 |
private: // new functions
|
|
98 |
CSifUiErrorInfo();
|
|
99 |
void ConstructL( Usif::TErrorCategory aErrorCategory,
|
|
100 |
TInt aErrorCode, TInt aExtendedErrorCode,
|
|
101 |
const TDesC& aErrorMessage, const TDesC& aErrorMessageDetails );
|
|
102 |
|
|
103 |
private: // data
|
|
104 |
Usif::TErrorCategory iErrorCategory;
|
|
105 |
TInt iErrorCode;
|
|
106 |
TInt iExtendedErrorCode;
|
|
107 |
HBufC* iErrorMessage;
|
|
108 |
HBufC* iErrorMessageDetails;
|
|
109 |
};
|
|
110 |
|
|
111 |
|
|
112 |
#include "sifuierrorinfo.inl"
|
|
113 |
|
|
114 |
#endif // C_SIFUIERRORINFO_H
|
|
115 |
|