Read With Abort
- Updated2025-07-30
- 3 minute(s) read
Reads the value from an Accumulator Tag channel, optionally clears the accumulator, and optionally signals the channel to abort. This endpoint is the same as the Read endpoint except that it has an abort input and an aborted? output. You can use the abort capability of the Accumulator Tag channel to close a channel abruptly, ignoring any data left in the channel buffer. You must use this endpoint together with the Write With Abort endpoint.

Inputs/Outputs
clear (T)
—
clear specifies whether to clear the accumulator or not. The default is TRUE.
channel
—
channel is the channel wire that connects this endpoint to a writer endpoint.
average (F)
—
average specifies whether to read the average of the elements from the channel or not. The default is FALSE.
abort
—
abort specifies whether to abort this channel. If abort is TRUE, this endpoint marks the channel as closed and ignores further calls to read. Meanwhile, the aborted? output returns TRUE on the next call of this endpoint.
element
—
element returns the data that this endpoint reads from the channel if average is FALSE. If average is TRUE, this output returns the average of the data from the channel.
count
—
count returns the number of times that the value of the channel has been updated since the last time the channel was cleared. This output returns its value even if the channel has aborted.
aborted?
—
aborted? returns TRUE if abort occurred on this endpoint or the writer endpoint connected to the channel. If aborted? is TRUE, further calls to this endpoint will do nothing except returning aborted? TRUE again. |
FPGA Module Details
The following details apply when you use this object in an FPGA VI.
| Single-Cycle Timed Loop | Not supported. |
| Usage | For arrays, this endpoint supports only fixed-sized one-dimensional arrays of supported data types. This endpoint does not support variable-sized arrays even if the array resolves to a single size at compile time. This endpoint does not support LabVIEW classes. If you use this endpoint with the single-precision floating-point data type, refer to the following topics for resource use, latency, and single-cycle Timed Loop support implications. |
| Notes | A channel terminal of a non-reentrant subVI can be connected to only one channel. If a non-reentrant subVI is called from multiple locations, the channel wires connected to a given terminal must resolve to the same channel at compile time. |
clear (T)
—
channel
—
element
—
count
—
aborted?
—