VTI Instruments EX1629, User Manual

Page: 121 / 346

www.vtiinstruments.com
EX1629 Command Set 121
vtex1629_error_message
F
UNCTION
P
ROTOTYPE
ViStatus vtex1629_error_message (ViSession vi , ViStatus statusCode , ViChar _VI_FAR errMessage[] );
F
UNCTION
P
ARAMETERS
vi = contains a session handle to the instrument. This handle is obtained by the function and remains valid until the
session is closed.
statusCode = an input status code corresponding to the error for which the error message is desired.
errMessage = a return string that contains the error message. This string should be at least 256 characters long.
D
ATA
I
TEM
R
ESET
V
ALUE
Not applicable to this function.
D
ESCRIPTION
This function returns the error message text associated with the statusCode parameter.
E
XAMPLE
ViSession instrumentHandle;
ViStatus status, code;
ViChar errorMessage[256];
…
status = vtex1629_error_message (instrumentHandle, code, errorMessage);