 | IVI-COM Warning Editor |
- Name
Specifies the name of the warning. The name must be all uppercase and having the following form:
S_<driverName>_<errorName>
Example: S_ACME4321_OPERATION_PENDING
- Value
Specifies the numeric value of the COM warning HRESULT. As per the IVI specifications, all IVI-COM instrument-specific warning codes have a base value of 0x00044000. This value appears as a read-only text box. The driver developer specifies the offset added to this base in the read-write text box. The resulting HRESULT value for the warning is the sum of these two.
- Message
This string will be formatted and placed in the COM error object so that client applications receive a textual description of the warning.
The message can contain replacement tags (%1, %2, etc.) used to insert runtime values into the warning message. For example, consider the following message definition:
Method %1 received only %2 bytes of %3 expected.
When the warning is fired from within the driver using the error reporter object, the developer supplies runtime values for the two replacement tags to produce a final message that would look similar to the following.
Method Fetch received only 350 bytes of 512 expected.
See Also