Owning Palette: TDMS Advanced Data Reference I/O Functions
Requires: Base Development System (Windows)
Copyright: (c) 2015 National Instruments. All rights reserved.
Writes data referenced by the data reference input to the specified .tdms file asynchronously. The data reference input typically refers to a portion of data owned by a component external to LabVIEW, such as a region of a DMA buffer that contains data you want to write to the .tdms file.
|tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Advanced Open function to open the refnum.|
|data reference specifies the external data value reference that points to the external data you want to write to the .tdms file. This input accepts an external data value reference containing a 1D or 2D array of integers, floating-point numbers, Booleans, or timestamps. If the disable buffering? input of the TDMS Advanced Open function is TRUE, the size of data that you wire to the data reference input must be a multiple of the sector size.|
|error in describes error conditions that occur before this node runs. This input provides standard error in functionality.|
|auto delete reference? specifies whether you want LabVIEW to delete the data reference automatically after the asynchronous operation completes. Deleting the data reference notifies the owner of the external memory that LabVIEW no longer needs access to the external memory. The default is TRUE. Set this value to FALSE when you want to continue using the reference after the asynchronous operation completes. For example, you might want to modify the data in LabVIEW before deleting the reference. If you set the value to FALSE, you must use the Delete Data Value Reference function to delete the data reference.|
|tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.|
|error out contains error information. This output provides standard error out functionality.|
This function can issue additional asynchronous writes while executing previously-issued asynchronous writes in the background. When the number of asynchronous writes in the background reaches the maximum value, this function waits until a previously-issued asynchronous write completes before issuing an additional asynchronous write. If the previously-issued asynchronous write does not complete within the timeout value, this function returns error code –2546. Use the TDMS Configure Asynchronous Writes (Data Ref) function to configure the maximum number of asynchronous writes and the timeout value.
Use the TDMS Get Asynchronous Write Status (Data Ref) function to query the number of pending asynchronous writes.