Click or drag to resize

Error Editor

The values entered in this editor are used to expose error codes via the driver's main header file (<prefix>.h) and to define the error message macro map maintained in the driver project's Errors.cpp file. That map is used to implement the ReportError and ReportErrorEx functions. See the topic Returning Errors from IVI-C Drivers for additional information.

Name

Name of the error. This name corresponds to the IVI-C macro name used in the <prefix>.h #define statement, except that the driver prefix is excluded. Error names consist only of capital letters, numbers, and the underscore character and must start with a capital letter.

Value

The numeric value of the error code macro used in the <prefix>.h #define statement. Note that IVI prescribes the base error code value, so only the offset is editable.

Message

Error message that will be set on the driver session when the error is reported. Client applications use the GetError function to retrieve the error message.

See Also

Download a complete CHM version of this documentation here.