Fetches I/Q data from a single record in an acquisition.

Syntax

int32 __stdcall RFmxInstr_FetchRawIQData(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 recordsToFetch, int64 samplesToRead, float64 *x0, float64 *dx, NIComplexSingle data[], int32 arraySize, int32 *actualArraySize, void *reserved)

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.

selectorString[in]char

Specifies a selector string. Pass an empty string.

timeout[in]float64

This parameterspecifies the timeout, in seconds, for fetching the raw IQ data. A value of -1 specifies that the function waits until all data is available. A value of 0 specifies the function immediately returns available data. The default value is 10.

recordsToFetch[in]int32

This parameter specifies the record to retrieve. Record numbers are zero-based. The default value is 0.

samplesToRead[in]int64

This parameter specifies the number of samples to fetch. A value of -1 specifies that RFmx fetches all samples. The default value is -1.

x0[out]float64 *

This parameter returns the start time of the first sample. The timestamp corresponds to the difference, in seconds, between the returned first sample and the reference trigger location.

dx[out]float64 *

This parameter returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.

data[out]NIComplexSingle

This parameter returns the acquired data as a cluster.

arraySize[in]int32

Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.

actualArraySize[out]int32 *

Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

reserved[out]void *

Reserved for future use. Any value passed to this parameter will be ignored.

Returns

Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxInstr_GetError function.

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors