Agilent-Defined VISA Attributes

Agilent VISA.NET

Agilent-Defined VISA Attributes

This topic summarizes the attributes specific to Agilent's VISA implementation. They are defined in the visa.h file distributed with Agilent VISA.

Note:  The #define AGVISA_ATTRIBUTES statement must appear before the #include <visa.h> statement if you are using any Agilent-defined attributes.

Note: Attributes are local or global. A local attribute only affects the session specified. A global attribute affects the specified device from any session. Attributes can also be read only (RO) and read/write (RW).

SCPI/TULIP Information

Attribute

Access Privileges

Data Type

Range

Used by

Description

VI_AGATTR_LOCKWAIT

RW

Local

ViBoolean

VI_TRUE / VI_FALSE

all VISA sessions

Indicates whether a lock-abiding VISA function that has been exclusively locked by another session will:

  • wait the timeout value to acquire the lock and then return VI_ERROR_TMO if it can't (VI_TRUE case) or
  • return a VI_ERROR_RSRC_LOCKED error immediately (VI_FALSE case).

 

TCPIP Attributes

Attribute

Access Privileges

Data Type

Range

Used by

Description

VI_AGATTR_INTERFACE_PROTOCOL

RO

 

Local

ViUInt32

VI_AGPROT_VXI11

VI_AGPROT_SICLLAN

VI_AGPROT_HISLIP

VI_AGPROT_UNKNOWN (on non-LAN sessions)

INSTR, INTFC

The interface protocol being used on this session.

 

VI_AGATTR_REMOTE_INTF_TYPE

RO

 

Local

ViUInt16

 

VI_INTF_GPIB

VI_INTF_ASRL

VI_INTF_VXI

VI_AGINTF_USRDEF

VI_AGINTF_LANINST

VI_AGINTF_RSIB

VI_AGINTF_SOCKET

VI_AGINTF_HISLIP

VI_INTF_USB

INSTR, INTFC

The type of remote interface for this session.

Notes:  

  1. Defined only  on TCPIP sessions.
  2. Remote VI_INTF_VXI sessions support only message-based  VXI devices.  VXI memory access functions are not supported over LAN (viPeek, viPoke, viMove, etc.).
  3. VI_AGINTF_USRDEF, VI_AGINTF_LANINST, and VI_AGINTF_RSIB are returned form VXI-11.3 and SICL-LAN.3 based instruments.
  4. VI_AGINTF_SOCKET is returned from a socket connection.
  5. VI_AGINTF_HISLIP is returned from a socket connection.

 

Export Attributes

Attribute

Access Privileges

Data Type

Range

Used by

Description

VI_AGATTR_EXPORT_ENABLED

RW

Global

ViBoolean

VI_TRUE /
VI_FALSE

All VISA sessions

Determines whether the resource should be exported and thus be visible to another vendor’s VISA implementation.  

The default value for this attribute depends on the VISA interface.

VI_AGATTR_FIND_ONLY_EXPORTED_RSRCS

RW

 

Local

ViBoolean

VI_TRUE /
VI_FALSE

DefaultRM sessions only

When this attribute is VI_TRUE, only those resources whose VI_AGATTR_EXPORT_ENABLED attribute is VI_TRUE will be returned from viFindRsrc() and viParseRsrc().

The default value is VI_FALSE, which means that all resources will be returned regardless of the value of their VI_AGATTR_EXPORT_ENABLED attribute.

 

GPIB Attributes

Attribute

Access Privileges

Data Type

Range

Used by

Description

VI_AGATTR_GPIB_T1_DELAY

RW

Global

ViiNT32

VI_AG_GPIB_T1DELAY_MIN to VI_AG_GPIB_T1DELAY_MAX (value is in nanoseconds)

GPIB INTFC resources

The value is the time of t1 delay in nanoseconds.  

Note:  Most GPIB interfaces support only a small number of t1 delays, so the actual t1 delay value used by the interface could be different than that specified.  The actual delay value used may be retrieved by calling viGetAttribute().

Miscellaneous Attributes

Attribute

Access Privileges

Data Type

Range

Used by

Description


VI_AGATTR_ALLOW_LOCAL_SPACE_FIFO

RW

Local

ViBoolean

VI_TRUE /
VI_FALSE (default)

All VISA sessions

This attribute was added in VISA 3.0. The VISA 3.0 spec required that in viMove, the srcIncrement/destIncrement from/to local memory is ignored. This means FIFO moves from/to local memory are disallowed. Agilent's VISA implementation allowed FIFO moves from/to local memory in VISA implementations prior to VISA 3.0 so this represents a change in behavior in VISA 3.0

Setting this attribute to VI_TRUE will revert to the pre-VISA 3.0 behavior and allow FIFO moves from/to local memory. Note: The default behavior can be changed by modifying the registry DWORD value: DefaultAllowLocalSpaceFifo to 1 in: HKLM\SOFTWARE\Agilent\IO Libraries\CurrentVersioin\VisaInfo

VI_AGATTR_INTFC_SERIALNUMBER

RO

 

Global

ViString

N/A

INTFC sessions only

This attribute was added in Suite 15.1. It returns the serial number of an interface. If the interface does not have a serial number it returns an empty string. Interfaces that don’t support this attribute will return the VI_ERROR_NSUP_ATTR status code.

VI_AGATTR_VISA_FRAMEWORK_DIR

RO

 

Global

ViString

N/A

INTFC sessions only

 

VI_AGATTR_IOLIBRARIES_DIR

RO

 

Global

ViString

N/A

INTFC sessions only

 

VI_AGATTR_IOLIBRARIES_REG_PATH

RO

 

Global

ViString

N/A

INTFC sessions only