Interface IVxi3

Note: Keysight's VISA COM does not support a COM server for VXI. The IVxi-related interfaces are listed in this help file because they are included in the global VISA COM library.

Description

The IVxi3 interface defines the methods and COM properties specific to VXI and GPIB-VXI INSTR sessions.

Methods

GetAttribute

Use of this method is discouraged. All the non-deprecated standard attributes are accessible via properties on the appropriate COM interfaces.

SetAttribute

Use of this method is discouraged. All the non-deprecated standard attributes are accessible via properties on the appropriate COM interfaces.

LockRsrc

Locks the resource.

UnlockRsrc

Unlocks the resource

Init

Opens the resource. This is the first method on IVisaSession or any of its derived interfaces to be called. In general, you will not call this method because you will use the Resource Manager to create resources.

Close

Closes the resource. Sending the resource's COM object's reference count to zero (and thus destroying the object) also executes a close, but this method may be useful for environments with garbage collection or other facilities that make object lifetimes non-deterministic.

AssertTrigger

Sources a software or hardware trigger dependent on the interface type.  For a VXI device, if the TriggerID property is TRIG_SW, then the device is sent the Word Serial Trigger command; for any other values of the attribute, a hardware trigger is sent on the line corresponding to the value of that attribute. 

For VXI software triggers, TRIG_PROT_DEFAULT is the only valid protocol. For VXI hardware triggers, TRIG_PROT_DEFAULT is equivalent to TRIG_PROT_SYNC.

CommandQuery

Sendsthe device a miscellaneous command or query and/or retrieves the response to a previous query.  This operation can send a command or query, or receive a response to a query previously sent to the device.  The mode parameter specifies whether to issue a command and/or retrieve a response, and what type or size of command and/or response to use.

Properties

ComponentVersion

A numeric version for this component.

SpecVersion

The VISA-defined version information for the specification version to which this component complies.

HardwareInterfaceName

The name of the hardware interface (GPIB, ASRL, etc.).

HardwareInterfaceNumber

The board number of the hardware interface.

HardwareInterfaceType

The type number of the hardware interface.

LockState

The current locking state of the interface.

OptionString

The option string corresponding to the current state of the resource.

ProgID

The programmatic ID that can be used by COM to create this object.

ResourceName

The VISA resource name of the currently open resource. This name is the canonical version of the resource name and therefore may vary from the resource string used to open/init the resource.

SessionType

The session type string, such as "INSTR" or "INTFC".

SoftwareManufacturerID

The ID number of the vendor of this software component.

SoftwareManufacturerName

The name of the vendor of this software component.

Timeout

The I/O timeout in milliseconds for I/O communication on this resource session.

LastStatus

The return value from the last method call on this interface. This property may be useful in Visual Basic, where positive return values, such as warnings and other non-error return values, cannot be retrieved.

See the Return Values page for a list of positive return values.

CommanderLA

Logical address of the commander of the VXI device used by the given session.

DestinationAccessPrivilege

Specifies the address modifier to be used in high-level access operations, such as OutXX and MoveOutXX, when writing to the destination.

DeviceClass

Represents the VXI-defined device class to which the resource belongs: either message based (VXI_CLASS_MESSAGE), register based (VXI_CLASS_REGISTER), extended (VXI_CLASS_EXTENDED), or memory (VXI_CLASS_MEMORY). VME devices are usually either register based or belong to a miscellaneous class (VXI_CLASS_OTHER).

FastDataChannel

Determines which FDC channel will be used to transfer the buffer.

FastDataChannelMode

Determines which FDC mode to use (Normal mode or Stream mode).

FastDataChannelUsePair

If set to true, a channel pair will be used for transferring data.  Otherwise, only one channel will be used.

ImmediateServant

Specifies whether the given device is an immediate servant of the controller running VISA.

LogicalAddress

Logical address of the VXI or VME device used by the given session.  For a VME device, the logical address is actually a pseudo-address in the range 256 to 511.

MainframeLogicalAddress

Logical address of a given device in the mainframe, usually the device with the lowest logical address.  Other possible values include the logical address of the slot-0 controller or of the parent-side extender.  Often, these are all the same value.  The purpose of this attribute is to provide a unique ID for each mainframe.  A VISA manufacturer can choose any of these values, but must be consistent across mainframes.  If this value is not known, the attribute value returned is UNKNOWN_LA.

ManufacturerID

Manufacturer identification number of the VXIbus device.

ManufacturerName

The name of the manufacturer, as a string.  The value of this property should be used for display purposes only and not for programmatic decisions, as the value can be different between VISA implementations and/or revisions.

MemoryBase

Base address of the device in VXIbus memory address space.  This base address is applicable to A24 or A32 address space.

MemorySize

Size of memory requested by the device in VXIbus address space.

MemorySpace

VXIbus address space used by the device.  The three types are A16 only, A16/A24, or A16/A32 memory address space.

ModelCode

Model code for the device.

ModelName

Model name of the device, as a string.  The value of this property should be used for display purposes only and not for programmatic decisions, as the value can be different between VISA implementations and/or revisions.

TriggerID

Identifier for the current triggering mechanism.

Slot

Physical slot location of the VXIbus device.  If the slot number is not known, UNKNOWN_SLOT is returned.

SourceAccessPrivilege

Specifies the address modifier to be used in high-level access operations, such as InXX and MoveInXX, when reading from the source.

TriggerSupport

Shows which VXI trigger lines this implementation supports.  This is a bit vector with bits 0-9 corresponding to TRIG_TTL0 through TRIG_ECL1.

Is4882Compliant

Specifies whether the device is IEEE 488.2 compliant.