An error lookup reference class. More...
#import <kfxKUTErrorInfo.h>
Class Methods | |
| (NSString *) | + findErrMsg: |
| Find an error message for a given error code. More... | |
| (NSString *) | + findErrDesc: |
| Find an error description for a given error code. More... | |
Detailed Description
An error lookup reference class.
Framework: libKfxUtilities
Import suggestion: #import <kfxLibUtilities/kfxUtilities.h>
This class contains class methods to determine the error description and probable cause or solution for the error based on an error code returned by the library. This class also includes enumerations for groups of errors that the libraries can generate. The groups of errors are assigned a section of hexidecimal errors, such that 0xGxxx G number indicates the group. See the KMC_XXX_BASE defines for these groups.
Method Documentation
◆ findErrDesc:()
| + (NSString *) findErrDesc: | (int) | inputErrorCode |
Find an error description for a given error code.
Use this class method to find an error description for a given error code, to discover how the error may occur and possible resolution. The method returns a string such that you could create an error pop up.
- Parameters
-
inputErrorCode Supply the error code for which you want an error description for corrective action if possible.
- Returns
- A string message suggesting what you might do to recover from the error.
◆ findErrMsg:()
| + (NSString *) findErrMsg: | (int) | inputErrorCode |
Find an error message for a given error code.
Use this class method to find an error message for a given error code. It returns the message string, formatted as follows: Module description: error message. Module description ends with the substring: "Error:", which is handy for parsing. The first module description phrase is suitable for a error pop up alert title. But you can design your own approach as you see fit.
- Parameters
-
inputErrorCode Supply the error code for which you want an error message describing the error.
- Returns
- A string describing the error.
The documentation for this class was generated from the following file: