You are here: NI Home > Support > Product Reference > Manuals > LabVIEW Real-Time Module 8.2 Help

Reads data from the shared memory of an RT Series plug-in device. You must wire RTRTX::0 to the device input of the RT Read VI to specify the RT target running on the RTX subsystem. Details  

Use the pull-down menu to select an instance of this VI.

Select an instanceRT Read Byte By NameRT Read Double By NameRT Read Long By NameRT Read Single By NameRT Read Word By Name

RT Read Byte By Name

	device is the name of the RTX subsystem (for example, RTRTX::0). The default is RT::0.
	byte offset is the location in memory to start reading data.
	previous data is the previous data read from shared memory.
	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 occurred 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 nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies 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.
	device out is the name of the RTX subsystem.
	next byte offset is the location in shared memory to read during the next iteration of this VI.
	data is the data read from shared memory.
	new data? is TRUE if the VI read new data, and FALSE if the VI read old data.
	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 front panel indicator 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 nonzero 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.

RT Read Double By Name

	device is the name of the RTX subsystem (for example, RTRTX::0). The default is RT::0.
	byte offset is the location in memory to start reading data.
	previous data is the previous data read from shared memory.
	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 occurred 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 nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies 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.
	device out is the name of the RTX subsystem.
	next byte offset is the location in shared memory to read during the next iteration of this VI.
	data is the data read from shared memory.
	new data? is TRUE if the VI read new data, and FALSE if the VI read old data.
	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 front panel indicator 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 nonzero 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.

RT Read Long By Name

	device is the name of the RTX subsystem (for example, RTRTX::0). The default is RT::0.
	byte offset is the location in memory to start reading data.
	previous data is the previous data from the array of data read from shared memory.
	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 occurred 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 nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies 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.
	device out is the name of the RTX subsystem.
	next byte offset is the location in shared memory to read during the next iteration of this VI.
	data is the data read from shared memory.
	new data? is TRUE if the VI read new data, and FALSE if the VI read old data.
	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 front panel indicator 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 nonzero 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.

RT Read Single By Name

	device is the name of the RTX subsystem (for example, RTRTX::0). The default is RT::0.
	byte offset is the location in memory to start reading data.
	previous data is the previous data read from shared memory.
	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 occurred 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 nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies 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.
	device out is the name of the RTX subsystem.
	next byte offset is the location in shared memory to read during the next iteration of this VI.
	data is the data read from shared memory.
	new data? is TRUE if the VI read new data, and FALSE if the VI read old data.
	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 front panel indicator 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 nonzero 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.

RT Read Word By Name

	device is the name of the RTX subsystem (for example, RTRTX::0). The default is RT::0.
	byte offset is the location in memory to start reading data.
	previous data is the previous data read from shared memory.
	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 occurred 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 nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies 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.
	device out is the name of the RTX subsystem.
	next byte offset is the location in shared memory to read during the next iteration of this VI.
	data is the data read from shared memory.
	new data? is TRUE if the VI read new data, and FALSE if the VI read old data.
	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 front panel indicator 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 nonzero 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.

RT Read Details

If you use the RT Read VI in a loop to read data from shared memory, you can pass the read data to the previous data input of the RT Read VI during the next iteration of the loop. For example, you can use a shift register to pass the data value to the next iteration of the loop.

The RT Read VI checks a read/write value located before the data in shared memory. If the read/write value = 1, indicating new data, the VI reads the data from shared memory. The RT Read VI then sets the read/write value to 0, indicating that the data has been read. If the read/write value = 0, indicating previously read data, the RT Read VI does not read data from shared memory and returns the previous data value as the data output.