viAssertUtilSignal

Agilent VISA.NET

viAssertUtilSignal

Syntax

viAssertUtilSignal(ViSession vi, ViUInt16 line);

Description

Asserts the specified utility bus signal. This operation can be used to assert either the SYSFAIL or SYSRESET utility bus interrupts on the VXIbus backplane. This operation is valid only on VXI Mainframe Backplane (BACKPLANE) and on Servant Device-Side (SERVANT) resource sessions.

Note: This function is not supported in Agilent VISA. You should assert SYSRESET (also known as HARD RESET in the VXI specification) only when it is necessary to promptly terminate operation of all devices in a VXIbus system. This is a serious action that always affects the entire VXIbus system.

Parameters

Name

Dir

Type

Description

vi

IN

ViSession

Unique logical identifier to a session.

line

IN

ViUInt16

Specifies the utility bus signal to assert. This can be: VI_UTIL_ASSERT_SYSRESET, VI_UTIL_ASSERT_SYSFAIL, or VI_UTIL_DEASSERT_SYSFAIL

Return Values

Type ViStatus

This is the function return status. It returns either a completion code or an error code as follows.

Completion Code

Description

VI_SUCCESS

The specified utility bus signal was successfully asserted to the device.

Error Codes

Description

VI_ERROR_INV_LINE

The value specified by the line parameter is invalid.

VI_ERROR_INV_SESSION
VI_ERROR_INV_OBJECT

The given session or object reference is invalid (both are the same value).

VI_ERROR_NSUP_OPER

The given vi does not support this function.

VI_ERROR_RSRC_LOCKED

Specified operation could not be performed because the resource identified by vi has been locked for this kind of access.

VI_ERROR_TMO

Timeout expired before function completed.

VI_SUCCESS

Operation completed successfully.

See Also

BACKPLANE resource description