 |
timeout ms The operation aborts if it does not complete within timeout ms.
If a timeout occurs, bit 14 of status is set. To disable timeouts, set timeout ms to 0. To use the 488.2 global timeout, leave this input unwired.
Use the SetTimeOut function to change the default value (the 488.2 global timeout) of timeout ms. Initially, timeout ms defaults to 10,000.
|
 |
address string sets the GPIB address of the GPIB controller itself.
address string contains the address of the GPIB device with which the function communicates. You can input both the primary and secondary addresses in address string by using the form primary+secondary. Both primary and secondary are decimal values, so if primary is 2 and secondary is 3, address string is 2+3.
If you do not specify an address, the functions do not perform addressing before they attempt to read and write the string. They assume you have either sent these commands another way or that another Controller is in charge and therefore responsible for the addressing. If the Controller is supposed to address the device but does not do so before the time limit expires, the functions terminate with GPIB error 6 (timeout) and set bit 14 in status. If the GPIB is not the Controller-In-Charge, do not specify address string.
When there are multiple GPIB Controllers that LabVIEW can use, a prefix to address string in the form ID:address (or ID: if no address is necessary) determines the Controller that a specific function uses. If a Controller ID is not present, the functions assume Controller (or bus) 0.
|
 |
byte count specifies the number of bytes the function reads from the GPIB device.
|
 |
mode specifies conditions, other than reaching byte count, for terminating the read.
The following table includes valid values and the corresponding EOS characters. Any mode not listed in the table indicates the decimal number of the desired EOS character. Refer to Multiline Interface Messages for more information about managing GPIB tasks.0 | No EOS character. The EOS termination mode is disabled. | 1 | EOS character is CR. Read terminated on EOI, byte count, or CR. | 2 | EOS character is LF. Read terminated on EOI, byte count, or LF. |
|
 |
error in describes error conditions that occur before this VI or function runs.
The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurs before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
 |
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
|
 |
code is the error or warning code. The default is 0.
If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.
|
 |
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
|
|
 |
data is the data the function read.
|
 |
status describes the state of the GPIB Controller.
The GPIB Read function terminates when it accomplishes one of the following tasks:
- Reads the number of bytes requested.
- Detects an error.
- Exceeds the time limit.
- Detects the END message (EOI asserted).
- Detects the EOS character (if this option is enabled by the value supplied to mode).
 | Note The function compares all eight bits when it checks for the EOS character. |
|
 |
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.
 |
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
|
 |
code is the error or warning code.
If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.
|
 |
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
|
|