Configures the maximum number of asynchronous reads, total amount of data to read, and the timeout value for the asynchronous reads. The timeout value applies to all subsequent asynchronous reads. You must use this function to configure the asynchronous reads before using the TDMS Advanced Asynchronous Read (Data Ref) function.

Note Before using this function, ensure that no asynchronous reads are pending.


icon

Inputs/Outputs

  • cgnrn.png 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.

  • cu32.png max asynchronous reads (4) —

    max asynchronous reads specifies the maximum number of asynchronous reads that can run simultaneously in the background. After the number of pending asynchronous reads reaches the maximum value, the TDMS Advanced Asynchronous Read (Data Ref) function waits for a pending asynchronous read to complete before issuing another asynchronous read. The value must be greater than zero. The default is 4.

  • ci64.png total size (in bytes) (-1) —

    total size specifies the total size, in bytes, of the data to read from the .tdms file. The default is –1, which specifies that the TDMS Advanced Asynchronous Read (Data Ref) function keeps issuing asynchronous reads until this function reaches the end of the .tdms file. Use this input in conjunction with the read process finished? output of the TDMS Advanced Asynchronous Read (Data Ref) function to control an asynchronous reading process.

  • cerrcodeclst.png error in (no error) —

    error in describes error conditions that occur before this node runs. This input provides standard error in functionality.

  • cdbl.png timeout (5 s) —

    timeout specifies the timeout value, in seconds, for the TDMS Advanced Asynchronous Read (Data Ref) function. When the number of pending asynchronous reads reaches the maximum value, the TDMS Advanced Asynchronous Read (Data Ref) function waits as long as the timeout value for a pending asynchronous read to complete before issuing another asynchronous read. If you do not wire data to this input, this function sets the value to 5.

  • ignrn.png tdms file out —

    tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.

  • ierrcodeclst.png error out —

    error out contains error information. This output provides standard error out functionality.