Interface IUsb

Description

The IUsb interface defines the methods and COM properties specific to USB INSTR sessions.

IUsb derives from IVisaSession.

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.

ControlREN

Controls the state of the USB REN interface line and, optionally, the remote/local state of the device. This operation asserts or deasserts the USB REN (Remote ENable) interface line according to the specified mode. 

The mode can also specify whether the device associated with this session should be placed in local state (before deasserting REN) or remote state (after asserting REN). This operation is valid only if the GPIB interface associated with the session object is currently the system controller.

An INSTR resource implementation of ControlREN for a USB system supports all documented modes.

ControlOut

Sends arbitrary data to a USB device on the default control port. You must be aware of how to use each parameter based on the relevant USB base or class specification, or based on a vendor-specific request definition.

Since the USBTMC specification does not currently define any standard control port requests in the direction of host-to-device, this function is intended for use with only vendor-defined requests. However, this function implementation should not check the bmRequestType parameter for this aspect.

ControlIn

Used to request arbitrary data from a USB device on the default control port. You must be aware of how to use each parameter based on the relevant USB base or class specification, or based on a vendor-specific request definition.

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.

ManufacturerID

Manufacturer identification number of the USB device.

ManufacturerName

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

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.

Is4882Compliant

Specifies whether the device is IEEE 488.2 compliant.

UsbSerialNumber

The serial number of the USB instrument. The value of this attribute should be used for display purposes only and not for programmatic decisions.

UsbInterfaceNumber

Specifies the USB interface number of this device to which this session is connected.

UsbProtocol

Specifies the USB protocol number.

MaximumInterruptSize

Specifies the maximum number of bytes that this USB device will send on the interrupt IN pipe. The default value is the same as the maximum packet size of the interrupt IN pipe.