AttributeType Enumeration

NI-VisaNS .NET Class Library Help for Visual Studio 2010

Edition Date: August 2012

Part Number: 370627F-01

»View Product Info
Download Help (Windows Only)

See Also


Specifies the .NET interface to NI-VISA driver-level attributes.

Namespace: NationalInstruments.VisaNS

Assembly: NationalInstruments.VisaNS (in NationalInstruments.VisaNS.dll) Version: 13.0.40.167

Syntax

Visual Basic (Declaration)
Public Enumeration AttributeType

C#
public enum AttributeType

Members

Member nameDescription
AsrlAllowTransmit This VISA attribute suspends or resumes transmission as if an XOFF or XON character has been received.
AsrlAvailNum The number of bytes available in the global receive buffer.
AsrlBaud The baud rate of the interface.
AsrlBreakLen This VISA attribute controls the duration in milliseconds of the break signal asserted when VI_ATTR_ASRL_END_OUT is set to VI_ATTR_ASRL_END_BREAK.
AsrlBreakState If set to Asserted, this VISA attribute suspends character transmission and places the transmission line in a break state until this attribute is reset to Unasserted.
AsrlConnected Specifies whether the port is properly connected to another port or device.
AsrlCtsState The current state of the Clear To Send (CTS) input signal.
AsrlDataBits The number of data bits contained in each frame (from 5 to 8).
AsrlDcdState The current state of the Data Carrier Detect (DCD) input signal.
AsrlDiscardNull This VISA attribute determines whether NUL characters are discarded or treated as normal data characters.
AsrlDsrState The current state of the Data Set Ready (DSR) input signal.
AsrlDtrState The current state of the Data Terminal Ready (DTR) input signal.
AsrlEndIn The method used to terminate read operations.
AsrlEndOut The method used to terminate write operations.
AsrlFlowCntrl The type of flow control used by the transfer mechanism.
AsrlParity The parity used with every frame transmitted and received.
AsrlReplaceChar The character to replace incoming characters that arrive with errors, such as parity error.
AsrlRIState The current state of the Ring Indicator (RI) input signal.
AsrlRtsState The Request To Send (RTS) output signal is manually asserted or unasserted.
AsrlStopBits The number of stop bits used to indicate the end of a frame.
AsrlWireMode This VISA attribute specifies the wire mode.
AsrlXOffChar The XOFF character used for XON/XOFF flow control (both input and output).
AsrlXOnChar The XON character used for XON/XOFF flow control (both input and output).
Buffer The address of a buffer that was used in an asynchronous operation.
CmdrLA The unique logical address of the commander of the VXI device used by the given session.
DestAccessPriv The address modifier used in high-level access operations, such as viOutXX() and viMoveOutXX(), when writing to the destination.
DestByteOrder The byte order used in high-level access operations, such as viOutXX() and viMoveOutXX(), when writing to the destination.
DestIncrement The number of elements that the destination offset is incremented after every transfer.
DevStatusByte The 488-style status byte of the local controller or device associated with this session.
DmaAllowEn This VISA attribute specifies whether I/O accesses use DMA or Programmed I/O.
EventType The unique logical identifier for the event type of the specified event.
FdcChnl The Fast Data Channel (FDC) used to transfer the buffer.
FdcGenSignalEn This value corresponds to the VI_ATTR_FDC_GEN_SIGNAL_EN attribute on the NI-VISA driver.
FdcMode The Fast Data Channel (FDC) mode to use (either normal or stream mode).
FdcUsePair This VISA attribute specifies whether one channel or a channel pair is used for transferring data.
FileAppendEn This VISA attribute specifies whether ReadToFile overwrites or appends when opening a file.
FirewireDestUpperOffset Specifies the upper 16 bits of the 48-bit destination address of the IEEE 1394 device.
FirewireLowerChipId Specifies the lower 32 bits of the 40-bit Chip ID of the IEEE 1394 device.
FirewireSrcUpperOffset Specifies the upper 16 bits of the 48-bit source address of the IEEE 1394 device.
FirewireUpperChipId Specifies the upper 8 bits of the 40-bit Chip ID of the IEEE 1394 device.
FirewireVendorId Specifies the 24-bit Vendor ID of the IEEE 1394 device.
GpibAddrState The specified GPIB interface is currently addressed to talk or listen, or is not addressed.
GpibAtnState The current state of the GPIB ATN (ATtentioN) interface line.
GpibCicState This VISA attribute specifies whether the specified GPIB interface is currently CIC (Controller-In-Charge).
GpibHs488CblLen The total number of meters of GPIB cable used in the specified GPIB interface.
GpibNdacState The current state of the GPIB NDAC (Not Data ACcepted) interface line.
GpibPrimaryAddr The primary address of the GPIB device used by the given session.
GpibReaddrEn This VISA attribute specifies whether to use repeat addressing before each read or write operation.
GpibRecvCicState The local controller has gained or lost CIC status.
GpibRenState The current state of the GPIB REN (Remote ENable) interface line.
GpibSecondaryAddr The secondary address of the GPIB device used by the given session.
GpibSrqState The current state of the GPIB SRQ (Service ReQuest) interface line.
GpibSysCntrlState This VISA attribute specifies whether the specified GPIB interface is currently the system controller.
GpibUnaddrEn This VISA attribute specifies whether to unaddress the device (Untalk and Unlisten) after each read or write operation.
ImmediateServ This VISA attribute specifies whether the device associated with this session is an immediate servant of the controller running VISA.
IntfInstName Human-readable text that describes the interface.
IntfNum The board number for the interface.
IntfParentNum The board number of the GPIB board to which the GPIB-VXI is attached.
IntfType The interface type of the session.
IntrStatusID The 32-bit Status/ID retrieved during the IACK cycle.
IOProt The specified protocol to use.
Is4882Compliant The device associated with this session is 488.2 compliant.
IsPxiExpress This VISA attribute specifies whether the device is a PCI Express or PXI Express device.
JobID The job ID of the asynchronous operation that has completed.
MainframeLA The lowest logical address in the mainframe.
ManfID The manufacturer identification number of the device.
ManfName The name of the manufacturer.
MaxQueueLength The maximum number of events that can be queued at any time on the session.
MemBase The base address of the device in VXIbus memory address space.
MemSize The size of memory requested by the device in VXIbus address space.
MemSpace The VXIbus address space used by the device. The three types are A16, A24, or A32 memory address space.
ModelCode The model code for the device.
ModelName The model name of the device.
OperName The name of the operation generating this event.
PxiBackplaneDestinationTriggerBus Specifies the destination segment to which to map triggers.
PxiBackplaneSourceTriggerBus Specifies the source segment from which to map triggers.
PxiBusNum The PCI bus number of the PCI or PXI device.
PxiChassisNum The PXI chassis number of the device.
PxiDevNum The PXI device number.
PxiDStarBusNum The differential star bus number of the device.
PxiDStarSetNum The number of the set of PXI differential star lines connected to the device.
PxiFuncNum The PXI function number. All devices have a function 0. Multifunction devices also support other function numbers.
PxiLinkWidth The PCI Express or PXI Express link width negotiated between the PCI Express or PXI Express host controller and the device.
PxiMaxLinkWidth The maximum PCI Express or PXI Express link width of the device.
PxiMemBaseBar0 PXI memory base address assigned to the specified BAR 0.
PxiMemBaseBar1 PXI memory base address assigned to the specified BAR 1.
PxiMemBaseBar2 PXI memory base address assigned to the specified BAR 2.
PxiMemBaseBar3 PXI memory base address assigned to the specified BAR 3.
PxiMemBaseBar4 PXI memory base address assigned to the specified BAR 4.
PxiMemBaseBar5 PXI memory base address assigned to the specified BAR 5.
PxiMemSizeBar0 Memory size used by the device in the specified BAR 0.
PxiMemSizeBar1 Memory size used by the device in the specified BAR 1.
PxiMemSizeBar2 Memory size used by the device in the specified BAR 2.
PxiMemSizeBar3 Memory size used by the device in the specified BAR 3.
PxiMemSizeBar4 Memory size used by the device in the specified BAR 4.
PxiMemSizeBar5 Memory size used by the device in the specified BAR 5.
PxiMemTypeBar0 Memory type used by the device in the specified BAR 0 (if applicable).
PxiMemTypeBar1 Memory type used by the device in the specified BAR 1 (if applicable).
PxiMemTypeBar2 Memory type used by the device in the specified BAR 2 (if applicable).
PxiMemTypeBar3 Memory type used by the device in the specified BAR 3 (if applicable).
PxiMemTypeBar4 Memory type used by the device in the specified BAR 4 (if applicable).
PxiMemTypeBar5 Memory type used by the device in the specified BAR 5 (if applicable).
PxiReceiveInterruptData Returns the first PXI or PCI register that was read in the successful interrupt detection sequence.
PxiReceiveInterruptSequence Returns the index of the interrupt sequence that detected the interrupt condition.
PxiSlotLBusLeft The slot number or special feature connected to the local bus left lines of the device.
PxiSlotLBusRight The slot number or special feature connected to the local bus right lines of the device.
PxiSlotLinkWidth The PCI Express or PXI Express link width of the PCI Express or PXI Express peripheral slot in which the device resides.
PxiSlotPath The slot path of the device.
PxiStarTrigBus The star trigger bus number of the device.
PxiStarTrigLine The PXI star line connected to the device.
PxiTrigBus The trigger bus number of the device.
RdBufOperMode The operational mode of the formatted I/O read buffer.
RdBufSize The current size of the formatted I/O input buffer for this session.
RecvIntrLevel The VXI interrupt level on which the interrupt was received.
RecvTcpipAddr This value corresponds to the VI_ATTR_RECV_TCPIP_ADDR attribute on the NI-VISA driver.
RecvTrigID The triggering mechanism on which the specified trigger event was received.
RetCount The actual number of elements that were asynchronously transferred.
RMSession The session of the Resource Manager that was used to open this session.
RsrcClass The resource class, such as INSTR, as defined by the canonical resource name.
RsrcImplVersion The resource version that uniquely identifies each of the different revisions or implementations of a resource.
RsrcLockState The current locking state of the resource.
RsrcManfID The VXI manufacturer ID of the vendor that implemented the VISA library.
RsrcManfName A string that corresponds to the manufacturer name of the vendor that implemented the VISA library.
RsrcName The unique identifier for a resource.
RsrcSpecVersion The resource version that uniquely identifies the version of the VISA specification to which the implementation is compliant.
SendEndEn This VISA attribute specifies whether to assert END during the transfer of the last byte of the buffer.
SigPStatusID The 16-bit Status/ID value retrieved during the IACK cycle or from the Signal register.
Slot The physical slot location of the VXIbus device.
SrcAccessPriv The address modifier to use in high-level access operations, such as In and MoveIn, when reading from the source.
SrcByteOrder The byte order to be used in high-level access operations, such as In and MoveIn, when reading from the source.
SrcIncrement The number of elements that the source offset is to be incremented after every transfer.
Status The return code of the operation generating this event.
SuppresEndEn This VISA attribute specifies whether to suppress the END bit termination.
TcpipAddr The TCPIP address of the device to which the session is connected.
TcpipDeviceName The LAN device name used by the VXI-11 protocol during connection.
TcpipHostname The host name of the device.
TcpipKeepAlive This VISA attribute requests that a TCP/IP provider enable the use of keep-alive packets on TCP connections.
TcpipNoDelay The Nagle algorithm is disabled when this VISA attribute is enabled (and vice versa).
TcpipPort The port number for a given TCPIP address.
Termchar The termination character.
TermcharEn A flag that determines whether the read operation terminates when a termination character is received.
TmoValue The minimum timeout value in milliseconds to use when accessing the device associated with the session.
TrigID The identifier for the current triggering mechanism.
UsbAltSetting The USB alternate setting.
UsbBulkInPipe The endpoint number of the USB bulk-in pipe.
UsbBulkInStatus This VISA attribute determines whether the USB bulk-in pipe is stalled or ready.
UsbBulkOutPipe The endpoint number of the USB bulk-out pipe.
UsbBulkOutStatus This VISA attribute determines whether the USB bulk-out pipe is stalled or ready.
UsbClass The USB class that this session uses.
UsbControlPipeThe endpoint number of the USB control pipe.
UsbEndIn Specifies the method used to terminate USB read operations.
UsbIntfcNum The USB interface number of the device to which this session is connected.
UsbIntrInPipe The endpoint number of the USB interrupt-in pipe.
UsbIntrInStatus This VISA attribute determines whether the USB interrupt-in pipe is stalled or ready.
UsbMaxIntrSize The maximum number of bytes that the USB device sends on an interrupt-in pipe.
UsbNumIntfcs The number of USB interfaces supported by the device.
UsbNumPipes The number of pipes supported by the USB interface.
UsbProtocol The USB protocol number.
UsbRecvIntrData The data that is received from the USB interrupt-in pipe.
UsbRecvIntrSize The size of the data that is received from the USB interrupt-in pipe.
UsbSerialNum The serial number of the USB instrument.
UsbSubclass The USB subclass that this session uses.
UserData The data used privately by the application for a particular session.
VxiDevClass The VXI-defined device class to which the resource belongs, either Message, Register, Extended, or Memory.
VxiDevCmdType This value corresponds to the VI_ATTR_VXI_DEV_CMD_TYPE attribute on the NI-VISA driver.
VxiDevCmdValue This value corresponds to the VI_ATTR_VXI_DEV_CMD_VALUE attribute on the NI-VISA driver.
VxiLA For an INSTR session, this VISA attribute specifies the logical address of the VXI or VME device used by the session. For a MEMACC or SERVANT session, this VISA attribute specifies the logical address of the local controller.
VxiTrigStatus The current state of the VXI trigger lines.
VxiTrigSupport This VISA attribute shows which VXI trigger lines this implementation supports.
VxiVmeIntrStatus The current state of the VXI/VME interrupt lines.
VxiVmeSysfailState The current state of the VXI/VME SYSFAIL (SYStem FAILure) backplane line.
WinAccess The modes in which the current window may be accessed.
WinAccessPriv The address modifier to use in low-level access operations, such as viMapAddress(), viPeekXX(), and viPokeXX(), when accessing the mapped window.
WinBaseAddr The base address of the interface bus to which this window is mapped.
WinByteOrder The byte order to use in low-level access operations, such as viMapAddress(), viPeekXX(), and viPokeXX(), when accessing the mapped window.
WinSize The size of the region mapped to this window.
WrBufOperMode The operational mode of the formatted I/O write buffer.
WrBufSize The current size of the formatted I/O output buffer for this session.

Remarks

This enumeration includes all the known NI-VISA driver attributes. You can use AttributeType with the GetAttribute and SetAttribute methods to manually get and set the NI-VISA driver attributes.
Note: Setting the NI-VISA driver attributes directly can cause unintended and unpredictable behavior and possibly data loss when used in conjunction with an already open session from this class library. Do not attempt to modify the state of a session on the NI-VISA driver directly with this enumeration unless the attribute you need is unavailable in the class library.

See Also

Reference

NationalInstruments.VisaNS Namespace

WAS THIS ARTICLE HELPFUL?

Not Helpful