Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

Instr

LabVIEW 2013 Help

Edition Date: June 2013

Part Number: 371361K-01

»View Product Info

Inherits from I/O Session class.

Long Name Description
VXI/VME Settings:Source Byte Order Specifies 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). Details
PXI/PCI Settings:PCI Resources:BAR5 Address Type Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0). Details
Serial Settings:Parity Specifies the parity used with every frame that is transmitted or received. Valid values include: (0) Parity None, (1) Parity Odd, (2) Parity Even, (3) Parity Mark, (4) Parity Space. Mark means that the parity bit exists and is always 1. Space means that the parity bit exists and is always 0. Details
Serial Settings:Number of Bytes at Serial Port Returns the number of bytes currently available at the serial port used by this session. Details
VXI/VME Settings:VXI Commander Logical Address Returns the logical address of the commander of the VXI device. Details
VXI/VME Settings:VXI Memory Base Address Returns the base address of the device in VXI memory space. Details
GPIB Settings:Unaddressing Specifies whether to unaddress the device (UNT and UNL) after each read or write operation. The default is FALSE. Details
PXI/PCI Settings:PCI Resources:BAR0 Address Type Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0). Details
Serial Settings:Data Bits Specifies the number of data bits contained in each frame. Valid values include 5-8. The data bits for each frame are located in the low-order bits of every byte stored in memory. Details
PXI/PCI Settings:PXI Chassis Number Returns the PXI chassis number of this device. A value of -1 means the chassis number is unknown. Other valid values are 0 to 255. Details
PXI/PCI Settings:Express Settings:Maximum Link Width Returns the maximum PCI Express link width of the device. A value of -1 indicates that the device is not a PXI/PCI Express device. Common values include 1, 2, 4, 8, and 16. Details
Serial Settings:Modem Line Settings:Break State Sets manual control of the serial port's break state. If asserted, this property suspends character transmission and places the transmission line in a break state until this property is unasserted. If you want VISA to send a break signal after each write operation automatically, use the Break Length (Break Len) and End Mode for Writes (ASRL End Out) properties instead. The default is Unasserted. Details
PXI/PCI Settings:PCI Resources:BAR3 Address Base Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless. Details
GPIB Settings:Readdressing Specifies whether to use repeat addressing before each read or write operation. The default is TRUE. Details
TCP/IP Settings:Computer Hostname Returns the host name of the device. If no host name is available, this property returns an empty string. Details
PXI/PCI Settings:Express Settings:Actual Link Width Returns the PCI Express link width negotiated between the PCI Express host controller and the device. A value of -1 indicates that the device is not a PXI/PCI Express device. Common values include 1, 2, 4, 8, and 16. Details
PXI/PCI Settings:PCI Device Number Returns the PCI device number of the PXI/PCI resource. Details
Serial Settings:Modem Line Settings:Line DTR State Asserts or unasserts the Data Terminal Ready (DTR) output signal manually. Details
Message Based Settings:Is 488.2 Compliant Returns whether the device is 488.2 compliant. Details
VXI/VME Settings:Immediate Servant Returns whether the VXI device is an immediate servant of the local controller. Details
Serial Settings:Baud Rate Specifies the baud rate of the given communications port. The rate is represented as an unsigned 32-bit integer so that any baud rate can be used, but the communications port usually requires a commonly used rate such as 300, 1200, 2400, or 9600 baud. Details
PXI/PCI Settings:PCI Resources:BAR4 Address Type Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0). Details
PXI/PCI Settings:PCI Resources:BAR4 Address Base Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless. Details
PXI/PCI Settings:PCI Resources:BAR2 Address Base Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless. Details
PXI/PCI Settings:PCI Resources:BAR3 Address Type Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0). Details
PXI/PCI Settings:Star Trigger Line Returns the PXI_STAR line connected to this device. Details
Serial Settings:Flow Control XOFF Character Specifies the value of the XOFF character used for XON/XOFF flow control (both directions). If XON/XOFF flow control (software handshaking) is not being used, the value of this property is ignored. The default is 0x13 (Control-S). Details
PXI/PCI Settings:Slot Path Returns the slot path of this device. Details
PXI/PCI Settings:Slot Local Bus Right Returns the slot number or special feature connected to the local bus right lines of this device. Details
TCP/IP Settings:Dot-Notation Address Returns the TCPIP address of the device to which the session is connected. This string is formatted in dot notation. Details
VXI/VME Settings:Destination Access Privilege Specifies 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). Details
PXI/PCI Settings:Express Settings:D-Star Set Returns the set of differential star lines connected to this device. A value of -1 means that the chassis is unidentified or does not have a timing slot. Details
PXI/PCI Settings:Express Settings:D-Star Bus Number Returns the differential star bus number of this device. A value of -1 means that the chassis is unidentified or does not have a timing slot. Details
PXI/PCI Settings:PCI Resources:BAR5 Address Base Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless. Details
FireWire Settings:Upper Chip ID Returns the upper chip ID for a FireWire® device. Details
Message Based Settings:Suppress End Enable Specifies whether to terminate a read operation due to an END condition. This property is relevant only in VISA Read and related operations. Details
Register Based Settings:Window Access Returns whether the current session has a mapped window, and if so, whether the window allows direct pointer dereferences. Details
Serial Settings:End Mode for Reads Specifies the method used to terminate read operations. Valid values include: (0) None, (1) Last Bit, (2) TermChar. If the value is (2) TermChar, then the value of the property Termination Character Enable (TermChar En) is ignored. The default is (2) TermChar. Details
VXI/VME Settings:VXI Memory Size Returns the size of memory requested by the device in VXI memory space. Details
Serial Settings:Flow Control XON Character Specifies the value of the XON character used for XON/XOFF flow control (both directions). If XON/XOFF flow control (software handshaking) is not being used, the value of this property is ignored. The default is 0x11 (Control-Q). Details
FireWire Settings:Destination Upper Offset Specifies the upper 16 bits of the 48-bit destination address for a FireWire® device. The default is 0xFFFF. Details
VXI/VME Settings:VXI Logical Address Returns the logical address of the VXI device. Details
PXI/PCI Settings:PCI Resources:BAR4 Address Size Specifies the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF. Details
Serial Settings:Modem Line Settings:Line RI State Specifies the current state of the Ring Indicator (RI) input signal. The RI signal is often used by modems to indicate that the telephone line is ringing. This property is read only except when the Wire Mode property is set to RS232/DCE or to RS232/AUTO with the hardware currently in the DCE state. Details
General Settings:Manufacturer Identification Returns the ID of the manufacturer that created the device. For VXI resources, this refers to the VXI Manufacturer ID. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Vendor ID. Otherwise, this refers to the Vendor ID. For USB resources, this refers to the Vendor ID (VID). Details
Message Based Settings:Termination Character Enable Specifies whether a read operation terminates when it receives the termination character. The default is FALSE. Details
Message Based Settings:Termination Character Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed). Details
TCP/IP Settings:LAN Device Name Returns the LAN device name used by the VXI-11 protocol (for example, inst0) during connection. Details
PXI/PCI Settings:PCI Resources:BAR5 Address Size Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF. Details
USB Settings:USB Interface Number Returns the USB interface number used by the given session. Details
PXI/PCI Settings:PCI Resources:BAR1 Address Size Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF. Details
Serial Settings:Modem Line Settings:Line CTS State Returns the current state of the Clear To Send (CTS) input signal. Details
Message Based Settings:Send End Enable Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE. Details
VXI/VME Settings:VXI Memory Address Space Returns the VXI address space used by the device. Details
VXI/VME Settings:Window Byte Order Specifies 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). Details
USB Settings:USB Protocol Returns the USB protocol used by the given session. Details
PXI/PCI Settings:Slot Local Bus Left Returns the slot number or special feature connected to the local bus left lines of this device. Details
General Settings:Slot Returns the physical slot location of the device. If the slot is unknown, the value returned is -1. Details
PXI/PCI Settings:PCI Resources:BAR2 Address Size Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF. Details
GPIB Settings:Secondary Address Returns 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). Details
VXI/VME Settings:Window Access Privilege Specifies 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). Details
VXI/VME Settings:Mainframe Logical Address Returns the lowest logical address in the mainframe in which the device resides. Details
USB Settings:Serial Number Returns the USB serial number of this device. Details
Serial Settings:Error Replacement Character Specifies the character to use to replace incoming characters that arrive with errors (such as a parity error). The default is 0. Details
General Settings:Model Name Returns the model name of the device. Details
Serial Settings:Stop Bits Specifies the number of stop bits used to indicate the end of a frame. Valid values include: (10) Stop One, (15) Stop One-and-a-Half, (20) Stop Two. Details
Serial Settings:Discard NUL Characters Specifies whether to discard each data byte whose value is 0. If this property is TRUE, read operations discard NUL characters. If this property is FALSE, read operations treat NUL characters as normal data characters. For binary transfers, set this property to FALSE. The default is FALSE. Details
FireWire Settings:Vendor ID Returns the vendor ID for a FireWire® device. Details
FireWire Settings:Lower Chip ID Returns the lower chip ID for a FireWire® device. Details
TCP/IP Settings:No Packet Delay Specifies whether the Nagle algorithm is enabled. The Nagle algorithm is disabled when this property is TRUE (and vice versa). The Nagle algorithm improves network performance by buffering written data until a full-size packet can be sent. This property is TRUE by default in VISA to verify that writes get flushed immediately. Details
Register Based Settings:Window Base Address Returns the base interface address to which this window maps. If the Window Access property is Not Mapped, the value of this property is meaningless. Details
Message Based Settings:File Append Enable Specifies whether VISA Read To File appends or overwrites (truncates) when opening a file. If this property is set to TRUE, VISA Read To File appends when opening a file. If this property is set to FALSE, VISA Read To File overwrites (truncates) when opening a file. The default is FALSE. Details
Serial Settings:End Mode for Writes Specifies the method used to terminate write operations. Valid values include: (0) None, (1) Last Bit, (2) TermChar, (3) Break. The default is (0) None. Details
General Settings:Allow DMA Transfers Specifies 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. Details
Serial Settings:Is Port Connected Returns whether the port is properly connected to another port or device. This property is valid only with serial drivers developed by National Instruments and documented to support this feature with the corresponding National Instruments hardware. Details
Serial Settings:Allow Transmit Specifies whether to allow transmission. If FALSE, the serial port suspends transmission as if an XOFF character has been received. If TRUE, it resumes transmission as if an XON character has been received. If XON/XOFF flow control (software handshaking) is not being used, FALSE is an invalid value. The default is TRUE. Details
General Settings:Trigger Identifier Specifies 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. Details
Register Based Settings:Destination Increment Count Specifies 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. Details
PXI/PCI Settings:Express Settings:Is PCI Express Returns whether the device is PXI/PCI or PXI/PCI Express. Details
Serial Settings:Break Length Specifies the duration (in milliseconds) of the break signal asserted when End Mode for Writes (ASRL End Out) is set to Break (3). Valid values include 1-500. The default is 250. If you want to control the assertion state and length of a break signal manually, use the VISA Serial Break VI instead. Details
VXI/VME Settings:Fast Data Channel:Use Channel Pairs Specifies whether transfers use a pair of FDC channels. If you do not set this property, transfers use only one FDC channel. The default is FALSE. Details
PXI/PCI Settings:PCI Resources:BAR0 Address Size Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF. Details
PXI/PCI Settings:PCI Resources:BAR3 Address Size Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF. Details
PXI/PCI Settings:Express Settings:Slot Link Width Returns the PCI Express link width of the PXI Express peripheral slot in which the device resides. A value of -1 indicates that the device is not a PXI Express device. Common values include 1, 4, and 8. Details
PXI/PCI Settings:PCI Resources:BAR0 Address Base Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless. Details
VXI/VME Settings:Source Access Privilege Specifies 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). Details
Register Based Settings:Window Size Returns the size of the region mapped to this window. If the Window Access property is Not Mapped, the value of this property is meaningless. Details
GPIB Settings:Line REN State Returns the current state of the GPIB REN (Remote ENable) interface line. Details
PXI/PCI Settings:PCI Bus Number Returns the PCI bus number of the PXI/PCI resource. Details
Interface Information:Interface Number of Parent Returns the board number of the parent device. Details
VXI/VME Settings:Fast Data Channel:Channel Mode Specifies whether FDC transfers use normal or streaming mode. The default is Normal. Details
Serial Settings:Modem Line Settings:Line DCD State Specifies the current state of the Data Carrier Detect (DCD) input signal. This is often used by modems to indicate the detection of a carrier (modem) on the phone line. This signal is also known as Receive Line Signal Detect (RLSD). This property is read only except when the Wire Mode property is set to RS232/DCE, or RS232/AUTO with the hardware currently in the DCE state. Details
TCP/IP Settings:Keep-Alive Packets Specifies whether to use keep-alive packets on TCP connections. Setting this property to TRUE requests that a TCP/IP provider enable the use of keep-alive packets on TCP connections. After the system detects a dropped connection, VISA returns a lost connection error code on subsequent I/O calls on the session. The time required for the system to detect the dropped connection depends on the system and is not settable. The default is FALSE. Details
Serial Settings:Wire Mode Specifies the current wire/transceiver mode. For RS485 hardware, this property is valid only with the RS485 serial driver developed by National Instruments. For RS232 hardware, the values RS232/DCE and RS232/AUTO are valid only with RS232 serial drivers developed by National Instruments and documented to support this feature with the corresponding National Instruments hardware. When this feature is not supported, RS232/DTE is the only valid value. Details
USB Settings:Maximum Interrupt Size Specifies the maximum size of data stored by any given USB interrupt. If a USB interrupt contains more data than this size, the data in excess of this size is lost. This property is read/write when the corresponding session is not enabled to receive USB interrupt events. When the session is enabled to receive USB interrupt events, this property is read only. Details
Register Based Settings:Source Increment Count Specifies 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. Details
General Settings:Model Code Returns the device model code assigned by the manufacturer. For VXI resources, this refers to the VXI Model Code. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Device ID. Otherwise, this refers to the Device ID. For USB resources, this refers to the Product ID (PID). Details
PXI/PCI Settings:Trigger Bus Number Returns the trigger bus number of this device. Details
VXI/VME Settings:VXI Device Class Returns the class to which the VXI or VME device belongs. Details
Serial Settings:Flow Control Specifies the flow control method used for both transmitting and receiving data. Valid values include: (0) Flow None, (1) Flow XON/XOFF, (2) Flow RTS/CTS, (3) Flow XON/XOFF and RTS/CTS, (4) Flow DTR/DSR, (5) Flow XON/XOFF and DTR/DSR. Certain values or combinations of values may not be supported by all serial ports and/or operating systems. Details
GPIB Settings:Primary Address Returns the primary address of the GPIB device used by the given session. Details
VXI/VME Settings:Destination Byte Order Specifies 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). Details
VXI/VME Settings:Supported VXI Trigger Lines Returns which VXI trigger lines this implementation supports. This property returns a bit vector with bits 0-9 corresponding to TTL0 through ECL1. Details
Serial Settings:Modem Line Settings:Line DSR State Returns the current state of the Data Set Ready (DSR) input signal. Details
PXI/PCI Settings:PCI Resources:BAR1 Address Type Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0). Details
PXI/PCI Settings:PCI Function Number Returns the PCI function number of the PXI/PCI resource. For most devices, the PCI function number is 0, but a multifunction device may have a function number up to 7. The meaning of a function number other than 0 is device-specific. Details
Message Based Settings:IO Protocol Specifies which protocol to use. In VXI, you can choose normal word serial or fast data channel. In GPIB, you can choose normal or high-speed HS-488 transfers. In serial, TCP/IP, or USB, you can choose normal transfers or 488.2-defined strings. In USBTMC, you can choose normal or vendor-specific transfers. The default is Normal. Details
General Settings:Manufacturer Name Returns the name of the manufacturer that created the device. Details
PXI/PCI Settings:PCI Resources:BAR2 Address Type Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0). Details
FireWire Settings:Source Upper Offset Specifies the upper 16 bits of the 48-bit source address for a FireWire® device. The default is 0xFFFF. Details
VXI/VME Settings:Fast Data Channel:Channel Number Specifies which FDC channel to use to transfer data buffers. Valid values include 0-7. Details
Serial Settings:Modem Line Settings:Line RTS State Asserts or unasserts the Request To Send (RTS) output signal manually. When the flow control is set to hardware handshaking, it is invalid to change this property. Details
PXI/PCI Settings:PCI Resources:BAR1 Address Base Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless. Details
FireWire Settings:Window Upper Offset Specifies the upper 16 bits of the 48-bit address for a FireWire® device when a window is mapped. The default is 0xFFFF. Details
PXI/PCI Settings:Star Trigger Bus Number Returns the star trigger bus number of this device. Details

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit