Class that holds the results of API calls. In case of API routine failure it contains the list of errors describing problems API encountered.
More...
◆ Status() [1/6]
◆ Status() [2/6]
Constructs an object containing given error
- Parameters
-
[in] | id | Identifier of the error |
◆ Status() [3/6]
Constructs an object containing given error
- Parameters
-
◆ Status() [4/6]
◆ ~Status()
◆ Status() [5/6]
- Deprecated:
- This item will be removed in a future release.
◆ Status() [6/6]
- Deprecated:
- This item will be removed in a future release.
◆ add() [1/3]
Adds an error to the object
- Parameters
-
[in] | id | Identifier of the error |
- Returns
- Reference to this object
◆ add() [2/3]
Adds an error to the object
- Parameters
-
- Returns
- Reference to this object
◆ add() [3/3]
Adds another status to this object
- Parameters
-
[in] | other | the status to add |
- Returns
- Reference to this object
◆ clear()
Clear all errors contained in this object
- Returns
- Description of all errors contained in the object
◆ getCollection()
- Deprecated:
- This item will be removed in a future release.
◆ getDescription()
const char* getDescription |
( |
| ) |
const |
Returns description of all errors contained in the object
- Returns
- Description of all errors contained in the object
◆ ok()
Checks that the object doesn't contain errors
- Returns
- true if no errors false otherwise
◆ operator bool()
Checks that the object doesn't contain errors
- Returns
- true if no errors false otherwise
◆ operator=()
Assignment oerator
- Parameters
-
[in] | other | the status to assign |
- Returns
- Reference to this object
◆ operator|=()
Operator, adds another status to this object
- Parameters
-
[in] | other | the status to add |
- Returns
- Reference to this object
The documentation for this class was generated from the following file: