Error Table

[This is preliminary documentation and subject to change.]

The Error table is used to look up error message formatting templates when processing errors with an error code set, but without a formatting template set (this is the normal situation).

The Error table has the following columns.

Column Type Key Nullable
Error Integer Y N
Message Template Y

Columns

Error
The integer error number, obtained from header file IError(...) macros.

Non-negative numbers only.

Message
Error formatting template. This table is initially generated by the build process to contain the debug format templates.

The following table lists reserved messages.
Number Description
0 (imsgInfo) Header for log-only messages, for example, "Info [1]. "
1 (imsgWarning) Header for warning messages, for example, "Warning [1]."
2 (imsgError) Header for error messages, for example, "Error [1]."
3 (imsgNotice) Header for notifications (log-only if log enabled), for example, "Notice [1]."
4 (imsgActionStart) Format template for action start message, for example, "Action: [1]. [2]"
5 (imsgDebugError) Format template for debug error code in final build.
6 (imsgDefaultError) Default format template if the error is not in the Error table.
7 (imsgLogHeader) Log header line (printf template for date/time).
8 (imsgLogTrailer) Log trailer line (printf template for date/time).

Remarks

The template does not include formatting for the error number in field 1. When processing the error, the installer attaches a header prefix to the template depending on the message type as described in the previous table. These headers are also stored in the Error table.