Interface IVxiMemacc

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 IVxiMemacc Interface provides the properties specific to VXI Memory Access resources.  These properties are a subset of the IVxi interface.

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.

In8

Reads in an 8-bit value from the specified memory space (assigned memory base + offset). This function takes the 8-bit value from the address space pointed to by space. The offset must be a valid memory address in the space.
If the session object is an INSTR session, the offset parameter specifies a relative offset from the start of the instrument's address space. If the session object is a MEMACC session, the offset parameter is an absolute offset from the start of memory in that VXI address space.

In16

Reads in an 16-bit value from the specified memory space (assigned memory base + offset). This function takes the 16-bit value from the address space pointed to by space. The offset must be a valid memory address in the space.
If the session object is an INSTR session, the offset parameter specifies a relative offset from the start of the instrument's address space. If the session object is a MEMACC session, the offset parameter is an absolute offset from the start of memory in that VXI address space.

In32

Reads in a 32-bit value from the specified memory space (assigned memory base + offset). This function takes the 32-bit value from the address space pointed to by space. The offset must be a valid memory address in the space.
If the session object is an INSTR session, the offset parameter specifies a relative offset from the start of the instrument's address space. If the session object is a MEMACC session, the offset parameter is an absolute offset from the start of memory in that VXI address space.

Out8

Writes an 8-bit value to the specified memory space (assigned memory base + offset). This function takes the 8-bit value and stores its contents to the address space pointed to by space. The offset must be a valid memory address in the space. 

If the session object is an INSTR session, the offset parameter specifies a relative offset from the start of the instrument's address space. If the session object is a MEMACC session, the offset parameter is an absolute offset from the start of memory in that VXI address space.

Out16

Writes an 16-bit value to the specified memory space (assigned memory base + offset). This function takes the 16-bit value and stores its contents to the address space pointed to by space. The offset must be a valid memory address in the space. 

If the session object is an INSTR session, the offset parameter specifies a relative offset from the start of the instrument's address space. If the session object is a MEMACC session, the offset parameter is an absolute offset from the start of memory in that VXI address space.

Out32

Writes a 32-bit value to the specified memory space (assigned memory base + offset). This function takes the 32-bit value and stores its contents to the address space pointed to by space. The offset must be a valid memory address in the space. 

If the session object is an INSTR session, the offset parameter specifies a relative offset from the start of the instrument's address space. If the session object is a MEMACC session, the offset parameter is an absolute offset from the start of memory in that VXI address space.

MoveIn8

Moves an 8-bit block of data from the specified memory space (assigned memory base + offset) to local memory.  This function reads the 8-bit value from the address space pointed to by space.  The offset must be a valid memory address in the space. 

If the session object is an INSTR session, the offset parameters specify relative offsets from the start of the instrument's address space.  If the session object is a MEMACC session, the offset parameters are absolute offsets from the start of memory in the specified VXI address space.

Note: The MoveInX functions do a block move of memory from a VXI device if the SourceIncrement property is one.  However, they do a FIFO read of a VXI memory location if the SourceIncrement property is zero.

MoveIn16

Moves an 16-bit block of data from the specified memory space (assigned memory base + offset) to local memory.  This function reads the 16-bit value from the address space pointed to by space.  The offset must be a valid memory address in the space. 

If the session object is an INSTR session, the offset parameters specify relative offsets from the start of the instrument's address space.  If the session object is a MEMACC session, the offset parameters are absolute offsets from the start of memory in the specified VXI address space.

Note: The MoveInX functions do a block move of memory from a VXI device if the SourceIncrement property is one.  However, they do a FIFO read of a VXI memory location if the SourceIncrement property is zero.

MoveIn32

Moves a 32-bit block of data from the specified memory space (assigned memory base + offset) to local memory.  This function reads the 32-bit value from the address space pointed to by space.  The offset must be a valid memory address in the space. 

If the session object is an INSTR session, the offset parameters specify relative offsets from the start of the instrument's address space.  If the session object is a MEMACC session, the offset parameters are absolute offsets from the start of memory in the specified VXI address space.

Note: The MoveInX functions do a block move of memory from a VXI device if the SourceIncrement property is one.  However, they do a FIFO read of a VXI memory location if the SourceIncrement property is zero.

MoveOut8

Moves an 8-bit block of data from local memory to the specified memory space (assigned memory base + offset).  This function writes the 8-bit value to the address space pointed to by space. The offset must be a valid memory address in the space.

If the session object is an INSTR session, the offset parameters specify relative offsets from the start of the instrument's address space. If the session object a MEMACC session, the offset parameters are absolute offsets from the start of memory in the specified VXI address space.

Note: The MoveOutX functions do a block move of memory from a VXI device if the DestinationIncrement property is 1. However, they do a FIFO read of a VXI memory location if the DestinationIncrement property is 0 (zero).

MoveOut16

Moves an 16-bit block of data from local memory to the specified memory space (assigned memory base + offset).  This function writes the 16-bit value to the address space pointed to by space. The offset must be a valid memory address in the space.

If the session object is an INSTR session, the offset parameters specify relative offsets from the start of the instrument's address space. If the session object a MEMACC session, the offset parameters are absolute offsets from the start of memory in the specified VXI address space.

Note: The MoveOutX functions do a block move of memory from a VXI device if the DestinationIncrement property is 1. However, they do a FIFO read of a VXI memory location if the DestinationIncrement property is 0 (zero).

MoveOut32

Moves a 32-bit block of data from local memory to the specified memory space (assigned memory base + offset).  This function writes the 32-bit value to the address space pointed to by space. The offset must be a valid memory address in the space.

If the session object is an INSTR session, the offset parameters specify relative offsets from the start of the instrument's address space. If the session object a MEMACC session, the offset parameters are absolute offsets from the start of memory in the specified VXI address space.

Note: The MoveOutX functions do a block move of memory from a VXI device if the DestinationIncrement property is 1. However, they do a FIFO read of a VXI memory location if the DestinationIncrement property is 0 (zero).

Move

Moves data from the specified source to the specified destination. The source and the destination can either be local memory or the offset of the interface with which this INSTR or MEMACC resource is associated. This operation uses the specified data width and address space.

If the session object is an INSTR session, the offset parameters specify relative offsets from the start of the instrument's address space. If session object is a MEMACC session, the offset parameters are absolute offsets from the start of memory in the specified VXI address space.

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.

DestinationBigEndian

Indicates whether the destination address space uses Big Endian or Little Endian byte order.

DestinationIncrement

Used by the MoveOut functions to determine whether to do a block move or a FIFO read.

SourceBigEndian

Indicates whether the source address space uses Big Endian or Little Endian byte order.

SourceIncrement

Used by the MoveIn functions to determine whether to do a block move or a FIFO read.

DestinationAccessPrivilege

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

SourceAccessPrivilege

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

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.