|
Synergy Color Management Component - SDK -
2018.0.80
|
SynColor SDK error status reporting class. More...
Public Member Functions | |
| SynStatus () | |
| Constructor. More... | |
| virtual | ~SynStatus () |
| Destructor. More... | |
| SynStatus (const SynStatus &rhs) | |
| Copy constructor. More... | |
| SynStatus & | operator= (const SynStatus &rhs) |
| Assignment operator. More... | |
| SYNCOLOR::ErrorId | getErrorCode () const |
| Error ID. More... | |
| void | setErrorCode (SYNCOLOR::ErrorId ID) |
| Set the error ID. More... | |
| const char * | getErrorMessage () const |
| Get the error message string. More... | |
| void | setErrorMessage (const char *msg) |
| Set the error message. More... | |
| operator bool () const | |
| Boolean operator where true means no error. More... | |
Protected Attributes | |
| char * | _errMsg |
| Error message string. More... | |
| SYNCOLOR::ErrorId | _errCode |
| Error ID. More... | |
SynColor SDK error status reporting class.
The SYNCOLOR::SynStatus class is composed of an error ID and a message string. A error ID other SYNCOLOR::ERROR_NONE indicates an error condition. See synColor/errorIds.h for the complete list. The error message strings contain useful contextual information. They are designed for user notifications posted in application interfaces. The error message strings are available for each of the SYNCOLOR::Language defined.
| SYNCOLOR::SynStatus::SynStatus | ( | ) |
Constructor.
|
virtual |
Destructor.
| SYNCOLOR::SynStatus::SynStatus | ( | const SynStatus & | rhs | ) |
Copy constructor.
| rhs | Instance to copy. |
Assignment operator.
| rhs | Instance to copy. |
| SYNCOLOR::ErrorId SYNCOLOR::SynStatus::getErrorCode | ( | ) | const |
Error ID.
| void SYNCOLOR::SynStatus::setErrorCode | ( | SYNCOLOR::ErrorId | ID | ) |
Set the error ID.
| ID | Error ID to assign. |
| const char* SYNCOLOR::SynStatus::getErrorMessage | ( | ) | const |
Get the error message string.
SynColor error message strings contain useful contextual information. These messages are designed for user notifications posted in application interfaces.
| void SYNCOLOR::SynStatus::setErrorMessage | ( | const char * | msg | ) |
Set the error message.
| msg | Message string to assign. |
| SYNCOLOR::SynStatus::operator bool | ( | ) | const |
Boolean operator where true means no error.
|
protected |
Error message string.
NULL if the ID is SYNCOLOR::ERROR_NONE.
|
protected |
Error ID.