FlexRIO API Reference

niFlexRIO_ReadStream2DF64

  • Updated2024-02-20
  • 1 minute(s) read

niFlexRIO_ReadStream2DF64

FlexRIO_Status niFlexRIO_ReadStream2DF64(NiFpga_Session session, int32_t streamInstance, int32_t timeoutInMs, size_t numberOfWfms, size_t numberOfElements, double* elementArray, FlexRIO_WfmInfo* wfmInfoArray);

Purpose

Reads data from a specified stream.

Parameters

Input
Name Type Description
session NiFpga_Session Specifies the reference to the currently open NiFpga session.
streamInstance int32_t Identifies an instance of a stream.
timeoutInMs int32_t Specifies a time limit in milliseconds.
numberOfWfms size_t Specifies the number of waveforms to output in elementArray.
numberOfElements size_t Specifies the number of elements to output in elementArray.
Output
Name Type Description
elementArray double* Outputs the data read from the stream.
wfmInfoArray FlexRIO_WfmInfo* Contains information about waveforms read from the stream.

Return Value

Name Type Description
returnValue FlexRIO_Status Reports the status of this operation. To obtain a text description of the status code, call niFlexRIO_GetError. The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience