Agilent Technologies E1439 manual Age1439errormessage, ErrorMessage

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_error_message

Returns error information obtained from function calls.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_error_message(ViSession id, ViStatus statusCode, ViChar

	errorMessage[]);
	Description
	age1439_error_message takes an error return value generated by a function and translates it to a
	readable string. This function includes host errors as well as firmware errors.
	Parameters
id	is the VXI instrument session pointer returned by the age1439_init function.
errorMessage	represents the error message string up to 256 characters long.
Note	For this parameter you must allocate a character array of at least 256 characters AGE1439_STR_
	LEN_MIN, including the null byte, prior to calling this function in any programming language.
statusCode	represents the instrument numeric error code.
	Return Value
	AGE1439_SUCCESS indicates that a function was successful.
	Values other than AGE1439_SUCCESS indicate an unknown error condition or other important
	status condition and may return VI_WARN_UNKNOWN_STATUS.
	See Also
	“age1439_init” on page 132, “age1439_error_query” on page 103, “Error messages” on page 199

102