VXI/GPIB-VXI/VME RBD Instr PropertiesDownload PDFSelected SectionSelected Section and Subsection(s)Entire ManualUpdated2024-07-306 minute(s) readLabVIEWAPI ReferenceLabVIEW G VXI/GPIB-VXI/VME RBD Instr Properties General Settings:Maximum Queue LengthSpecifies the maximum number of events that can be queued at any time on the given session. This property is read/write until the first time you call VISA Enable Event on a session. Thereafter, it is read only. The default is 50.General Settings:Resource ClassReturns the resource class of the resource string used to open the given session. For example, if the resource string for a given session is COM1 or ASRL1::INSTR, this property returns INSTR, regardless of the class of the I/O control.General Settings:Resource Lock StateReturns the current locking state of the resource associated with the given session. The resource can be unlocked, locked with an exclusive lock, or locked with a shared lock. The default is Unlocked.General Settings:Resource NameReturns the unique identifier for a resource.General Settings:Timeout ValueSpecifies the minimum timeout value, in milliseconds, to use when accessing the device. Note that the actual timeout that VISA returns may be higher than the one requested. The default is 2000.General Settings:User DataSpecifies a data value for the private use of an application. The VISA implementation stores this value in a per-session location, so that user data on other sessions does not affect the user data on this session. VISA does not use this property for any purpose.Interface Information:Interface DescriptionSpecifies human-readable text that describes the given interface. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.Interface Information:Interface NumberReturns the board number for the given interface.Interface Information:Interface TypeSpecifies the interface type of the given session.Version Information:Resource Manufacturer IdentificationReturns a value that corresponds to the VXI manufacturer ID of the manufacturer that created the VISA implementation.Version Information:Resource Manufacturer NameReturns the name of the manufacturer that created the implementation. This is not related to the device manufacturer attributes. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.Version Information:Version of ImplementationReturns the version of a given implementation. This value is defined by the individual manufacturer and increments with each new revision. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version.Version Information:Version of SpecificationReturns the value that uniquely identifies the version of the VISA specification to which the implementation complies. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version.General Settings:Allow DMA TransfersSpecifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality.General Settings:Manufacturer IdentificationReturns the ID of the manufacturer that created the device. For VXI resources, this refers to the VXI Manufacturer ID. For PXI/PCI resources, this refers to the Subsystem Vendor ID (SVID) if it is nonzero; otherwise, this refers to the Vendor ID (VID). For USB resources, this refers to the Vendor ID (VID).General Settings:Manufacturer NameReturns the name of the manufacturer that created the device. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.General Settings:Model CodeReturns the device model code assigned by the manufacturer. For VXI resources, this refers to the VXI Model Code. For PXI/PCI resources, if the Subsystem Vendor ID is nonzero, this refers to the Subsystem ID (SSID); otherwise, this refers to the Device ID (DID). For USB resources, this refers to the Product ID (PID).General Settings:Model NameReturns the model name of the device. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.General Settings:SlotReturns the physical slot location of the device. If the slot is unknown, the value returned is -1.General Settings:Trigger IdentifierSpecifies which trigger mechanism to use. In VXI systems, for example, you can choose between software triggers and hardware triggers on a specific trigger line. The default is Software.GPIB Settings:Line REN StateReturns the current state of the GPIB REN (Remote ENable) interface line.GPIB Settings:Primary AddressReturns the primary address of the GPIB device used by the given session.GPIB Settings:Secondary AddressReturns the secondary address of the GPIB device used by the given session. If the device does not have a secondary address, the value of this property is 65535 (0xFFFF).Interface Information:Interface Number of ParentReturns the board number of the parent device.Register Based Settings:Destination Increment CountSpecifies the number of elements by which to increment the destination address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move Out X operations always read from the same element, essentially treating the destination as a FIFO register.Register Based Settings:Source Increment CountSpecifies the number of elements by which to increment the source address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move In X operations always read from the same element, essentially treating the source as a FIFO register.Register Based Settings:Window AccessReturns whether the current session has a mapped window, and if so, whether the window allows direct pointer dereferences.Register Based Settings:Window Base AddressReturns the base interface address to which this window maps. If the Window Access property is Not Mapped, the value of this property is undefined.Register Based Settings:Window SizeReturns the size of the region mapped to this window. If the Window Access property is Not Mapped, the value of this property is undefined.VXI/VME Settings:Destination Access PrivilegeSpecifies the address modifier to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Data/Privileged (0).VXI/VME Settings:Destination Byte OrderSpecifies the byte order to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Big Endian (0).VXI/VME Settings:Immediate ServantReturns whether the VXI device is an immediate servant of the local controller.VXI/VME Settings:Mainframe Logical AddressReturns the lowest logical address in the mainframe in which the device resides.VXI/VME Settings:Source Access PrivilegeSpecifies the address modifier to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Data/Privileged (0).VXI/VME Settings:Source Byte OrderSpecifies the byte order to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Big Endian (0).VXI/VME Settings:Supported VXI Trigger LinesReturns which VXI trigger lines this implementation supports. This property returns a bit vector with bits 0-9 corresponding to TTL0 through ECL1.VXI/VME Settings:VXI Commander Logical AddressReturns the logical address of the commander of the VXI device.VXI/VME Settings:VXI Device ClassReturns the class to which the VXI or VME device belongs.VXI/VME Settings:VXI Logical AddressReturns the logical address of the VXI device.VXI/VME Settings:VXI Memory Address SpaceReturns the VXI address space used by the device.VXI/VME Settings:VXI Memory Base AddressReturns the base address of the device in VXI memory space.VXI/VME Settings:VXI Memory SizeReturns the size of memory requested by the device in VXI memory space.VXI/VME Settings:VXI Trigger DirectionsSpecifies the directions of the mapped TTL triggers lines. This is a bit vector where bits 0-7 represent TTL triggers 0-7 respectively. A bit value of 0 means the corresponding line is routed out of the frame, and a value of 1 means the line is routed into the frame. Lines must be enabled using VXI/VME Settings:VXI Trigger Lines Enable.VXI/VME Settings:VXI Trigger Lines EnableSpecifies which VXI TLL triggers have mappings. This is a bit vector where bits 0-7 represent TTL triggers 0-7 respectively. A bit value of 0 means the corresponding trigger line is unmapped, and 1 means a mapping exists. Use VXI/VME Settings:VXI Trigger Directions to set an enabled line's direction.VXI/VME Settings:Window Access PrivilegeSpecifies the address modifier to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Data/Privileged (0).VXI/VME Settings:Window Byte OrderSpecifies the byte order to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Big Endian (0).Parent topic: I/O Session PropertiesWas this information helpful?YesNo
VXI/GPIB-VXI/VME RBD Instr Properties General Settings:Maximum Queue LengthSpecifies the maximum number of events that can be queued at any time on the given session. This property is read/write until the first time you call VISA Enable Event on a session. Thereafter, it is read only. The default is 50.General Settings:Resource ClassReturns the resource class of the resource string used to open the given session. For example, if the resource string for a given session is COM1 or ASRL1::INSTR, this property returns INSTR, regardless of the class of the I/O control.General Settings:Resource Lock StateReturns the current locking state of the resource associated with the given session. The resource can be unlocked, locked with an exclusive lock, or locked with a shared lock. The default is Unlocked.General Settings:Resource NameReturns the unique identifier for a resource.General Settings:Timeout ValueSpecifies the minimum timeout value, in milliseconds, to use when accessing the device. Note that the actual timeout that VISA returns may be higher than the one requested. The default is 2000.General Settings:User DataSpecifies a data value for the private use of an application. The VISA implementation stores this value in a per-session location, so that user data on other sessions does not affect the user data on this session. VISA does not use this property for any purpose.Interface Information:Interface DescriptionSpecifies human-readable text that describes the given interface. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.Interface Information:Interface NumberReturns the board number for the given interface.Interface Information:Interface TypeSpecifies the interface type of the given session.Version Information:Resource Manufacturer IdentificationReturns a value that corresponds to the VXI manufacturer ID of the manufacturer that created the VISA implementation.Version Information:Resource Manufacturer NameReturns the name of the manufacturer that created the implementation. This is not related to the device manufacturer attributes. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.Version Information:Version of ImplementationReturns the version of a given implementation. This value is defined by the individual manufacturer and increments with each new revision. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version.Version Information:Version of SpecificationReturns the value that uniquely identifies the version of the VISA specification to which the implementation complies. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version.General Settings:Allow DMA TransfersSpecifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality.General Settings:Manufacturer IdentificationReturns the ID of the manufacturer that created the device. For VXI resources, this refers to the VXI Manufacturer ID. For PXI/PCI resources, this refers to the Subsystem Vendor ID (SVID) if it is nonzero; otherwise, this refers to the Vendor ID (VID). For USB resources, this refers to the Vendor ID (VID).General Settings:Manufacturer NameReturns the name of the manufacturer that created the device. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.General Settings:Model CodeReturns the device model code assigned by the manufacturer. For VXI resources, this refers to the VXI Model Code. For PXI/PCI resources, if the Subsystem Vendor ID is nonzero, this refers to the Subsystem ID (SSID); otherwise, this refers to the Device ID (DID). For USB resources, this refers to the Product ID (PID).General Settings:Model NameReturns the model name of the device. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.General Settings:SlotReturns the physical slot location of the device. If the slot is unknown, the value returned is -1.General Settings:Trigger IdentifierSpecifies which trigger mechanism to use. In VXI systems, for example, you can choose between software triggers and hardware triggers on a specific trigger line. The default is Software.GPIB Settings:Line REN StateReturns the current state of the GPIB REN (Remote ENable) interface line.GPIB Settings:Primary AddressReturns the primary address of the GPIB device used by the given session.GPIB Settings:Secondary AddressReturns the secondary address of the GPIB device used by the given session. If the device does not have a secondary address, the value of this property is 65535 (0xFFFF).Interface Information:Interface Number of ParentReturns the board number of the parent device.Register Based Settings:Destination Increment CountSpecifies the number of elements by which to increment the destination address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move Out X operations always read from the same element, essentially treating the destination as a FIFO register.Register Based Settings:Source Increment CountSpecifies the number of elements by which to increment the source address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move In X operations always read from the same element, essentially treating the source as a FIFO register.Register Based Settings:Window AccessReturns whether the current session has a mapped window, and if so, whether the window allows direct pointer dereferences.Register Based Settings:Window Base AddressReturns the base interface address to which this window maps. If the Window Access property is Not Mapped, the value of this property is undefined.Register Based Settings:Window SizeReturns the size of the region mapped to this window. If the Window Access property is Not Mapped, the value of this property is undefined.VXI/VME Settings:Destination Access PrivilegeSpecifies the address modifier to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Data/Privileged (0).VXI/VME Settings:Destination Byte OrderSpecifies the byte order to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Big Endian (0).VXI/VME Settings:Immediate ServantReturns whether the VXI device is an immediate servant of the local controller.VXI/VME Settings:Mainframe Logical AddressReturns the lowest logical address in the mainframe in which the device resides.VXI/VME Settings:Source Access PrivilegeSpecifies the address modifier to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Data/Privileged (0).VXI/VME Settings:Source Byte OrderSpecifies the byte order to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Big Endian (0).VXI/VME Settings:Supported VXI Trigger LinesReturns which VXI trigger lines this implementation supports. This property returns a bit vector with bits 0-9 corresponding to TTL0 through ECL1.VXI/VME Settings:VXI Commander Logical AddressReturns the logical address of the commander of the VXI device.VXI/VME Settings:VXI Device ClassReturns the class to which the VXI or VME device belongs.VXI/VME Settings:VXI Logical AddressReturns the logical address of the VXI device.VXI/VME Settings:VXI Memory Address SpaceReturns the VXI address space used by the device.VXI/VME Settings:VXI Memory Base AddressReturns the base address of the device in VXI memory space.VXI/VME Settings:VXI Memory SizeReturns the size of memory requested by the device in VXI memory space.VXI/VME Settings:VXI Trigger DirectionsSpecifies the directions of the mapped TTL triggers lines. This is a bit vector where bits 0-7 represent TTL triggers 0-7 respectively. A bit value of 0 means the corresponding line is routed out of the frame, and a value of 1 means the line is routed into the frame. Lines must be enabled using VXI/VME Settings:VXI Trigger Lines Enable.VXI/VME Settings:VXI Trigger Lines EnableSpecifies which VXI TLL triggers have mappings. This is a bit vector where bits 0-7 represent TTL triggers 0-7 respectively. A bit value of 0 means the corresponding trigger line is unmapped, and 1 means a mapping exists. Use VXI/VME Settings:VXI Trigger Directions to set an enabled line's direction.VXI/VME Settings:Window Access PrivilegeSpecifies the address modifier to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Data/Privileged (0).VXI/VME Settings:Window Byte OrderSpecifies the byte order to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Big Endian (0).Parent topic: I/O Session Properties
VXI/GPIB-VXI/VME RBD Instr Properties General Settings:Maximum Queue LengthSpecifies the maximum number of events that can be queued at any time on the given session. This property is read/write until the first time you call VISA Enable Event on a session. Thereafter, it is read only. The default is 50.General Settings:Resource ClassReturns the resource class of the resource string used to open the given session. For example, if the resource string for a given session is COM1 or ASRL1::INSTR, this property returns INSTR, regardless of the class of the I/O control.General Settings:Resource Lock StateReturns the current locking state of the resource associated with the given session. The resource can be unlocked, locked with an exclusive lock, or locked with a shared lock. The default is Unlocked.General Settings:Resource NameReturns the unique identifier for a resource.General Settings:Timeout ValueSpecifies the minimum timeout value, in milliseconds, to use when accessing the device. Note that the actual timeout that VISA returns may be higher than the one requested. The default is 2000.General Settings:User DataSpecifies a data value for the private use of an application. The VISA implementation stores this value in a per-session location, so that user data on other sessions does not affect the user data on this session. VISA does not use this property for any purpose.Interface Information:Interface DescriptionSpecifies human-readable text that describes the given interface. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.Interface Information:Interface NumberReturns the board number for the given interface.Interface Information:Interface TypeSpecifies the interface type of the given session.Version Information:Resource Manufacturer IdentificationReturns a value that corresponds to the VXI manufacturer ID of the manufacturer that created the VISA implementation.Version Information:Resource Manufacturer NameReturns the name of the manufacturer that created the implementation. This is not related to the device manufacturer attributes. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.Version Information:Version of ImplementationReturns the version of a given implementation. This value is defined by the individual manufacturer and increments with each new revision. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version.Version Information:Version of SpecificationReturns the value that uniquely identifies the version of the VISA specification to which the implementation complies. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version.General Settings:Allow DMA TransfersSpecifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality.General Settings:Manufacturer IdentificationReturns the ID of the manufacturer that created the device. For VXI resources, this refers to the VXI Manufacturer ID. For PXI/PCI resources, this refers to the Subsystem Vendor ID (SVID) if it is nonzero; otherwise, this refers to the Vendor ID (VID). For USB resources, this refers to the Vendor ID (VID).General Settings:Manufacturer NameReturns the name of the manufacturer that created the device. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.General Settings:Model CodeReturns the device model code assigned by the manufacturer. For VXI resources, this refers to the VXI Model Code. For PXI/PCI resources, if the Subsystem Vendor ID is nonzero, this refers to the Subsystem ID (SSID); otherwise, this refers to the Device ID (DID). For USB resources, this refers to the Product ID (PID).General Settings:Model NameReturns the model name of the device. Note: Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.General Settings:SlotReturns the physical slot location of the device. If the slot is unknown, the value returned is -1.General Settings:Trigger IdentifierSpecifies which trigger mechanism to use. In VXI systems, for example, you can choose between software triggers and hardware triggers on a specific trigger line. The default is Software.GPIB Settings:Line REN StateReturns the current state of the GPIB REN (Remote ENable) interface line.GPIB Settings:Primary AddressReturns the primary address of the GPIB device used by the given session.GPIB Settings:Secondary AddressReturns the secondary address of the GPIB device used by the given session. If the device does not have a secondary address, the value of this property is 65535 (0xFFFF).Interface Information:Interface Number of ParentReturns the board number of the parent device.Register Based Settings:Destination Increment CountSpecifies the number of elements by which to increment the destination address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move Out X operations always read from the same element, essentially treating the destination as a FIFO register.Register Based Settings:Source Increment CountSpecifies the number of elements by which to increment the source address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move In X operations always read from the same element, essentially treating the source as a FIFO register.Register Based Settings:Window AccessReturns whether the current session has a mapped window, and if so, whether the window allows direct pointer dereferences.Register Based Settings:Window Base AddressReturns the base interface address to which this window maps. If the Window Access property is Not Mapped, the value of this property is undefined.Register Based Settings:Window SizeReturns the size of the region mapped to this window. If the Window Access property is Not Mapped, the value of this property is undefined.VXI/VME Settings:Destination Access PrivilegeSpecifies the address modifier to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Data/Privileged (0).VXI/VME Settings:Destination Byte OrderSpecifies the byte order to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Big Endian (0).VXI/VME Settings:Immediate ServantReturns whether the VXI device is an immediate servant of the local controller.VXI/VME Settings:Mainframe Logical AddressReturns the lowest logical address in the mainframe in which the device resides.VXI/VME Settings:Source Access PrivilegeSpecifies the address modifier to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Data/Privileged (0).VXI/VME Settings:Source Byte OrderSpecifies the byte order to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Big Endian (0).VXI/VME Settings:Supported VXI Trigger LinesReturns which VXI trigger lines this implementation supports. This property returns a bit vector with bits 0-9 corresponding to TTL0 through ECL1.VXI/VME Settings:VXI Commander Logical AddressReturns the logical address of the commander of the VXI device.VXI/VME Settings:VXI Device ClassReturns the class to which the VXI or VME device belongs.VXI/VME Settings:VXI Logical AddressReturns the logical address of the VXI device.VXI/VME Settings:VXI Memory Address SpaceReturns the VXI address space used by the device.VXI/VME Settings:VXI Memory Base AddressReturns the base address of the device in VXI memory space.VXI/VME Settings:VXI Memory SizeReturns the size of memory requested by the device in VXI memory space.VXI/VME Settings:VXI Trigger DirectionsSpecifies the directions of the mapped TTL triggers lines. This is a bit vector where bits 0-7 represent TTL triggers 0-7 respectively. A bit value of 0 means the corresponding line is routed out of the frame, and a value of 1 means the line is routed into the frame. Lines must be enabled using VXI/VME Settings:VXI Trigger Lines Enable.VXI/VME Settings:VXI Trigger Lines EnableSpecifies which VXI TLL triggers have mappings. This is a bit vector where bits 0-7 represent TTL triggers 0-7 respectively. A bit value of 0 means the corresponding trigger line is unmapped, and 1 means a mapping exists. Use VXI/VME Settings:VXI Trigger Directions to set an enabled line's direction.VXI/VME Settings:Window Access PrivilegeSpecifies the address modifier to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Data/Privileged (0).VXI/VME Settings:Window Byte OrderSpecifies the byte order to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Big Endian (0).Parent topic: I/O Session Properties