User`s guide

4-42 Agilent E6432A Microwave Synthesizer User’s Guide

HPE6432_error_message

ViStatus HPE6432_error_message (ViSession instrumentHandle,

ViStatus errorCode, ViChar errorMessage[]);

Purpose

This function converts a status code returned by an instrument driver

function into a user-readable string.

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.

You can pass VI_NULL for this parameter. This is useful when the

Initialize function fails.

Default Value: VI_NULL

errorCode

Variable Type ViStatus

This parameter is the return Status from any of the instrument driver

functions.

errorMessage

Variable Type ViChar[]

This parameter returns the user-readable message string that

corresponds to the status code you specify.

You must pass a ViChar array with at least 256 bytes.

Return Value

This return value reports the status of the Error Message function.

To obtain further information about the status that is returned, refer to

“Error-Code and Fail-Code Messages” on page 3-93.