If a C function call fails, XMS can store information about why the call failed in an error block.
For more information about the error block and its contents, see The error block.
Return code | Meaning |
---|---|
XMS_OK | The call completed successfully. |
XMS_E_INVALID_ERROR_BLOCK | The call failed because the error block that was passed to the function was not valid. |
Any other value | The call failed for some other reason. |
This class is a helper class.
Function | Description |
---|---|
xmsErrorClear | Clear the contents of the error block. |
xmsErrorCreate | Create an error block. |
xmsErrorDispose | Delete the error block. |
xmsErrorGetErrorCode | Get the error code. |
xmsErrorGetErrorData | Get the error data. |
xmsErrorGetErrorString | Get the error string. |
xmsErrorGetJMSException | Get the exception code. |
xmsErrorGetLinkedError | Get the handle for the next error block in the chain of error blocks. |
xmsRC xmsErrorDispose(xmsHErrorBlock *errorBlock);
Only the first error block in a chain of error blocks can be explicitly deleted. By deleting the first error block in a chain, all subsequent error blocks in the chain are also deleted.
If an application tries to delete an error block that is already deleted, the call is ignored.
xmsRC xmsErrorGetErrorCode(xmsHErrorBlock errorBlock, xmsINT *errorCode);
For more information about the error code, see The error block.
xmsRC xmsErrorGetErrorData(xmsHErrorBlock errorBlock, xmsCHAR *buffer, xmsINT bufferLength, xmsINT *actualLength);
For more information about the error data, see The error block.
For more information about how to use this function, see C functions that return a string by value.
xmsRC xmsErrorGetErrorString(xmsHErrorBlock errorBlock, xmsCHAR *buffer, xmsINT bufferLength, xmsINT *actualLength);
For more information about the error string, see The error block.
For more information about how to use this function, see C functions that return a string by value.
xmsRC xmsErrorGetJMSException(xmsHErrorBlock errorBlock, xmsJMSEXP_TYPE *exceptionCode);
For more information about the exception code, see The error block.
xmsRC xmsErrorGetLinkedError(xmsHErrorBlock errorBlock, xmsHErrorBlock *linkedError);
Get the handle for the next error block in the chain of error blocks.