Rogue Wave Views Studio Package API Reference Guide |
Rogue Wave Views Documentation Home |
Inspector class. More...
#include <ivstudio/inspectors/insperr.h>
Inherits IlvStObject.
Public Types |
Public Member Functions | |
IlvStIError (const char *msg=0, Severity severity=Fatal) | |
Constructor from a single message. More... | |
IlvStIError (const char *msg, const char *param1, Severity severity=Fatal) | |
Constructor from a computed message. More... | |
IlvStIError (const char *msg, const char *param1, const char *param2, Severity severity=Fatal) | |
Constructor from a computed message. More... | |
virtual char * | getMessage (IlvDisplay *display) const |
Returns the error message. More... | |
Severity | getSeverity () const |
Returns the severity level of the error. More... | |
void | setSeverity (Severity severity) |
Sets the severity level of the error. More... | |
Inspector class.
Library: ivstudio
Errors generated by inspector classes are objects of this class. This class defines an error message and a severity level.
Constructor from a single message.
msg | The error message, it can be a key to a message database. |
severity | The error severity. |
Constructor from a computed message.
This error message contains one or more %1
substrings, which will be replaced by the param1 parameter. Let us suppose that msg equals to "The name %1 is not valid"
, and param1 is "2b3"
the final error message will be as follows "The name 2b3 is not valid"
.
msg | The error message, it can be a key to a message database. |
param1 | The value of the placeholder "%1" . |
severity | The error severity. |
IlvStIError::IlvStIError | ( | const char * | msg, |
const char * | param1, | ||
const char * | param2, | ||
Severity | severity = Fatal |
||
) |
Constructor from a computed message.
This error message contains one or more %1
and %2
substrings, which will be replaced by the param1 and param2 parameters, respectively. Let us suppose that msg equals to "The %1 county is not in %2"
, param1 is "Madison"
, and param2 is "France"
, the final error message will be: "The Madison county is not in France"
.
msg | The error message, it can be a key to a message database. |
param1 | The value of the named value "%1". |
param2 | The value of the named value "%2". |
severity | The error severity. |
|
virtual |
Returns the error message.
display | It is used to retrieve the message matching the key when the message is stored into a message database. |
Severity IlvStIError::getSeverity | ( | ) | const |
Returns the severity level of the error.
void IlvStIError::setSeverity | ( | Severity | severity | ) |
Sets the severity level of the error.
severity | The new error severity. |
© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.