TIXRET_xxx return values
The extension DLL's TixHandler function must return an integer value in the pMessage->lResult field to indicate the result. The applicable result codes depend on the message type. In general, positive values denote "success" in some form, whereas negative values indicate an error while handling the message. The following result codes are defined.
| Result code | Value | Description |
|---|---|---|
| TIXRET_NOTHANDLED | 0 | Message was not handled. For completeness only; you can more easily achieve the same result by returning FALSE (zero) from TixHandler. |
| Success codes. Should be used to indicate successful execution of the handler, even if the result is a rejection of the input (for example, an invalid customer registration code). | ||
| TIXRET_SUCCESS | 1 | Generic "success" indication if no more specific result applies. |
| TIXRET_REJECT | 2 | Indicates that the input or general condition must be rejected. InstallMate will refuse to continue if this result is returned. |
| TIXRET_NOREGISTRATION | 3 | Indicates that no registration query is required. Refer to TIXMSG_INIT_REGISTRATION for details. |
| Error codes. Should only be used to indicate handler execution failures. | ||
| TIXRET_ERROR | -1 | Generic "failure" indication if no more specific result applies. |
| TIXRET_INTERNALERROR | -2 | The extension DLL encountered some sort of internal error but is able to continue with the setup process. |
| TIXRET_ABORT | -3 | The extension DLL encountered some sort of internal error or detected a condition that is deemed fatal. In response to this code, InstallMate aborts the current session. The extension DLL will receive a TIXMSG_ABORT_PROCESSING message, possibly followed by cleanup messages if the abort happened during TIXSES_INSTALL. |
| TIXRET_EXCEPTION | -4 | Set by the extension DLL wrapper in the installer if an exception propagated out of TixHandler. The extension DLL will be disabled for the remainder of the session. |