Read Trace (String) VI
- Updated2024-11-20
- 5 minute(s) read
Reads the historical data for a given variable using the specified time interval, up to the max points per trace specified. You must manually select the polymorphic instance to use.
Use the pull-down menu to select an instance of this VI.

Inputs/Outputs
![]() timeout specifies the maximum time, in seconds, that this VI waits for reading data from the Citadel database. The default is 30. A timeout value of less than or equal to 0 specifies no timeout, which means this VI waits indefinitely until this VI receives data from the Citadel database. ![]() max points per trace specifies the maximum number of points to read from the database. This VI returns all available points of this trace between start timestamp and stop timestamp in the following cases: max points per trace is less than zero. The number of the data points between start timestamp and stop timestamp is less than the max points per trace. If max points per trace is zero, this VI returns no point for the trace. The default is -1. ![]() database URL specifies the computer name and the database name where the Citadel database resides. Enter the database URL in the format \\computer\database. ![]() trace name specifies the trace that this VI uses for the data operation. You can specify either a Shared Variable reference or an existing trace for this parameter. If the trace is not logged in the historical database, this VI returns an empty trace. ![]() time interval is the span of time between the start timestamp and stop timestamp. If you do not wire this input, this VI reads all data logged up to now.
![]() error in describes error conditions that occur before this node runs. This input provides standard error in functionality. ![]() options specifies the format settings for the data as this VI reads the trace.
![]() database URL out returns the computer name and the database name that specify where the Citadel database resides. The format is \\computer\database. ![]() historical trace is the historical trace for the input trace name that is read from the historical database.
![]() quality is the data quality of the trace(s) read. A value of zero indicates good quality. ![]() error out contains error information. This output provides standard error out functionality. |
Read Trace Details
If database URL is unwired, this VI reads the trace name from the database associated with the default DSC Module process.
If you do not wire time interval, this VI returns all historical data for the trace, up to max points in trace specified. If you do not wire max points in trace, this VI returns all points between the start and stop timestamps set in time interval.
Examples
Refer to the NIHyperTrend Graph XML Configuration.lvproj in the labview\examples\lvdsc\HMI Design\NIHyperTrend Graph XML Configuration directory for an example of using the Read Trace VI.