Interface IGpibIntfcMessage

Description

The IGpibIntfcMessage interface provides the subset of text stream features present on a GPIB INTFC resource.

IGpibIntfcMessage 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.

AssertTrigger

Asserts a software or hardware trigger dependent on the interface type. For a GPIB device, the device is addressed to listen, and then the GPIB GET command is sent.

Read

Synchronously transfers data from a device. The data that is read is returned in the SAFEARRAY pBuffer. This function returns only when the transfer terminates. Only one synchronous read function can occur at any one time.

A read can terminate successfully due to receiving the requested number of bytes, receiving the read termination character (if enabled), or receiving the END signal.

ReadString

Synchronously transfers data from a device. The data that is read is returned in the BSTR pBuffer. This function returns only when the transfer terminates. Only one synchronous read function can occur at any one time.

A read can terminate successfully due to receiving the requested number of bytes, receiving the read termination character (if enabled), or receiving the END signal.

Write

Synchronously transfers data to a device. The data to be written is in the SAFEARRAY parameter buffer. This function returns only when the transfer terminates. Only one synchronous write function can occur at any one time.

WriteString

Synchronously transfers data to a device. The data to be written is in the BSTR parameter buffer. This function returns only when the transfer terminates. Only one synchronous write function can occur at any one time.

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.

SendEndEnabled

Enables/disables sending the END signal on the last byte of a write.

TerminationCharacter

The ASCII character used to end reading. Setting this property does not enable/disable the sending of this character; that is done by the TerminationCharacterEnabled property. The default character in most VISA implementations and most instruments is ASCII code 10 (linefeed).

TerminationCharacterEnabled

Enables/disables ending reads upon reception of the termination character. Enabling this property does not cause the termination character to be appended to writes.