MKS Integrity 2007 Integrations Builder Guide

Chapter 3: Using the MKS API
34
Some C API functions return NULL if an error has occurred, rather than an error code. For
these functions, you need to retrieve the error code in a different way.
For functions that return pointers to structs, like mksCmdRunnerGetSession(),
mksSessionGetIntegrationPoint(), mksCmdRunnerExecCmd(), and
mksCmdRunnerExecArr, use the mksGetError()function to retrieve the last generated
error, and the mksAPIStrError() function to retrieve the error message for the related error
code, for example:
mksResponse response = NULL;
response = mksCmdRunnerExecCmd(cr, cmd, NO_INTERIM);
if (response == NULL) {
rtn = mksGetError();
/* Handle the error here. */
}
NOTE The return value of mksGetError() is only updated after making a call to a
function that does not return mkstrn or void. For example, calling
mksResultGetMessage() after calling mksResultGetField() does not reset
the return value of mksGetError() as was set by the mksResultGetField()
function.
For the remaining functions that return NULL, use the mksGetError() function to retrieve
the mksrtn error code value, and the mksAPIStrError() function to retrieve the string
associated with the error.
Application Error Codes
The application error codes represent only the generic application exceptions. There are
many more specific exceptions that are possible within each generic application exception.
Each specific exception is mapped to an exported exception name used for API exception
reporting. The specific exception that occurred can be identified using the
mksAPIExceptionGetId() method.
The following tables list the application error codes that can occur, what they mean, and the
reason why they occur.
Error
Code
Description Reason for Error
300 General application exception Processing or validation error within MKS Integrity
or MKS Source.
301 Unsupported application Application passed in with command is unknown/
invalid.
302 Internal application error Internal error occurred on integration point while
executing command.
303 No such element error Attempted to access element that does not exist,
for example, field.