Instrument Control (INSTR) Resource Events

This version of the IO Libraries Suite supports Windows and Linux. Available utilities, APIs, help files and features vary by operating system. Variations are flagged in help with these icons:  for Windows and for Linux.

In the following tables, AP = Access Privilege, RO - Read Only, and RW = Read/Write.

VI_EVENT_SERVICE_REQUEST

Notification that a service request was received from the device.

Supported: 

Event Attribute

Attribute Value

Description

AP

Data Type

Range

VI_ATTR_EVENT_TYPE

 0x3FFF4010UL

Unique logical identifier of the event.

RO

ViEventType

VI_EVENT_SERVICE_REQ

 

VI_EVENT_VXI_SIGP

Notification that a VXIbus signal or VXIbus interrupt was received from the device.

Supported:  (Windows only)

Event Attribute

Attribute Value

Description

AP

Data Type

Range

VI_ATTR_EVENT_TYPE

 0x3FFF4010UL

Unique logical identifier of the event.

RO

ViEventType

VI_EVENT_VXI_SIGP

VI_ATTR_SIGP_STATUS_ID

 0x3FFF4011UL

The 16-bit Status/ID value retrieved during the IACK cycle or from the Signal register.

RO

ViUInt16

0 to FFFFh

 

VI_EVENT_TRIG

Notification that a trigger interrupt was received from the device. For VISA, the only triggers that can be sensed are VXI hardware triggers on the assertion edge (SYNC and ON trigger protocols only).

Supported: 

Event Attribute

Attribute Value

Description

AP

Data Type

Range

VI_ATTR_EVENT_TYPE

 0x3FFF4010UL

Unique logical identifier of the event.

RO

ViEventType

VI_EVENT_TRIG

VI_ATTR_RECV_TRIG_ID

 0x3FFF4012UL

The identifier of the triggering mechanism on which the specified trigger event was received.

RO

ViInt16

VI_TRIG_TTL0 to VI_TRIG_TTL11;
VI_TRIG_ECL0 to VI_TRIG_ECL5;
VI_TRIG_STAR_INSTR*
           

* Keysight VISA can also return VI_TRIG_PANEL_IN (exception to the VISA Specification).

VI_EVENT_IO_COMPLETION

Notification that an asynchronous operation has completed.

Supported: 

Event Attribute

Attribute Value

Description

AP

Data Type

Range

VI_ATTR_EVENT_TYPE

 0x3FFF4010UL

Unique logical identifier of the event.

RO

ViEventType

VI_EVENT_IO_COMPLETION

VI_ATTR_STATUS

 0x3FFF4025UL

Return code of the asynchronous I/O operation that has completed.

RO

ViStatus

N/A

VI_ATTR_JOB_ID

 0x3FFF4006UL

Job ID of the asynchronous operation that has completed.

RO

ViJobId

N/A

VI_ATTR_BUFFER

 0x3FFF4027UL

Address of a buffer that was used in an asynchronous operation.

RO

ViBuf

N/A

VI_ATTR_RET_COUNT

32-bit: 0x3FFF4026UL

64-bit: 0x3FFF4028UL

Actual number of elements that were asynchronously transferred.

RO

ViUInt32

0 to FFFFFFFFh

VI_ATTR_OPER_NAME

 0xBFFF4042UL

Name of the operation generating the event.

RO

ViString

N/A

VI_ATTR_RET_COUNT_32

 0x3FFF4026UL

Actual number of elements that were asynchronously transferred.

RO

ViUInt32

0 to FFFFFFFFh

VI_ATTR_RET_COUNT_64*

 0x3FFF4028UL

Actual number of elements that were asynchronously transferred.

RO

ViUInt64

0 to FFFFFFFFFFFFFFFFh

*Defined only for frameworks that are 64-bit native.

VI_EVENT_USB_INTR

Notification that a vendor-specific USB interrupt was received from the device.

Supported: 

Event Attribute

Attribute Value

Description

AP

Data Type

Range

VI_ATTR_EVENT_TYPE

 0x3FFF4010UL

Unique logical identifier of the event.

RO

ViEventType

 

VI_EVENT_USB_INTR

VI_ATTR_USB_RECV_INTR_SIZE

 

 0x3FFF41B0UL

Specifies the size of the data that was received from the USB interrupt-IN pipe. This value will never be larger than the sessions value of VI_ATTR_

USB_MAX_INTR_SIZE.

RO

ViUInt16

0 to FFFFh

VI_ATTR_USB_RECV_INTR_DATA

 0xBFFF41B1UL

Specifies the actual data that was received from the USB interrupt-IN pipe. Querying this attribute copies the contents of the data to the users buffer. The users buffer must be sufficiently large enough to hold all of the data.

RO

ViBuf

N/A

VI_ATTR_STATUS

 0x3FFF4025UL

Specifies the status of the read operation from the USB interrupt-IN pipe. If the device sent more data than the user specified in VI_ATTR_USB_MAX_INTR_SIZE, then this attribute value will contain an error code.

RO

ViStatus

N/A

VI_EVENT_PXI_INTR

Notification that a PCI Interrupt was received from the device.

Supported:  (Windows only)

Event Attribute

Attribute Value

Description

AP

Data Type

Range

VI_ATTR_EVENT_TYPE

 0x3FFF4010UL

PCI Interrupt was received from the device.

RO

ViEventType

VI_EVENT_PXI_INTR

VI_EVENT_VXI_VME_INTR (NOT IMPLEMENTED)

- Notification that a VXIbus interrupt was received from the device.

NOT IMPLEMENTED IN KEYSIGHT VISA.

Event Attribute

Attribute Value

Description

AP

Data Type

Range

VI_ATTR_EVENT_TYPE

0x3FFF4010UL

Unique logical identifier of the event.

RO

ViEventType

VI_EVENT_VXI_VME_INTR

VI_ATTR_RECV_INTR_LEVEL

 

 0x3FFF4041UL

VXI interrupt level on which the interrupt was received.

RO

VIInt16

1 to 7, VI_UNKNOWN_LEVEL

VI_ATTR_INTR_STATUS_ID

0x3FFF4023UL

32-bit status/ID retrieved during the IACK cycle.

RO

ViUInt32

0 to FFFFFFFFh

 

See also: Instrument Control (INSTR) Resource.