User`s guide

Agilent E6432A Microwave Synthesizer User’s Guide 4-43
HPE6432_error_query
ViStatus HPE6432_error_query (ViSession instrumentHandle,
ViStatus *errorCode, ViChar errorMessage[]);
Purpose
This function queries the synthesizer and returns an error code and a
corresponding error message from the instrument’s error queue.
This function can be used to clear the errors from the synthesizer’s
error queue.
The synthesizer can generate a list of error-code and fail-code messages.
• Error-Code Messages- If the synthesizer produces an error-code
message, insight is provided to the user about what could be going
wrong.
• Fail-Code Messages- If the synthesizer produces a fail-code message,
a hardware failure is being reported and the synthesizer must be
repaired. These messages begin with the word FAIL and cannot be
cleared using the HPE6432_ClearErrors or
HPE6432_error_query functions.
Each time the HPE6432_error_query function is called, one error code
and its corresponding message is returned from the instrument’s error
queue. Unless the error code and its corresponding error message is due
to a failure (indicated as FAIL), both the error code and its
corresponding error message are removed from the instrument’s error
queue.
Parameter List
instrumentHandle
Variable Type ViSession
This is the ViSession handle that is obtained from the Initialize
function. The instrumentHandle identifies a particular instrument
session.
errorCode
Variable Type ViStatus (passed by reference)
This parameter returns the error code read from the instrument's error
code queue.
errorMessage
Variable Type ViStatus (passed by reference)
This parameter returns the error message string read from the
instrument's error message queue.