RFSA C Reference

niRFSA_ConfigureNumberOfSamples

  • Updated2025-02-03
  • 2 minute(s) read

niRFSA_ConfigureNumberOfSamples

ViStatus niRFSA_ConfigureNumberOfSamples(ViSession vi, ViConstString channelList, ViBoolean numberOfSamplesIsFinite, ViInt64 samplesPerRecord);

Purpose

Configures the number of samples in a finite acquisition or configures the device to continuously acquire samples.

If you configure the device for finite acquisition, it acquires the specified number of samples and then stops the acquisition. You can configure the device to acquire multiple records using the niRFSA_ConfigureNumberOfRecords function. Each record contains the number of samples specified in this function.

If you configure the device to continuously acquire samples, it continues acquiring data until you call the niRFSA_Abort function to abort the acquisition. The device stores data in onboard memory in a circular fashion. After the device fills the memory, it starts overwriting previously acquired data from the beginning of the memory buffer. Retrieve the samples as they are being acquired, using one of the niRFSA fetch I/Q functions, to avoid overwriting data before you retrieve it.

Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

I/Q Modulation

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function.
channelList ViConstString Identifies which channels to apply settings. Specify an empty string as the value of this parameter.
numberOfSamplesIsFinite ViBoolean Specifies whether to configure the device to acquire a finite number of samples or to acquire samples continuously. The default is VI_TRUE.

VI_TRUEThe device acquires a finite number of samples.
VI_FALSEThe device acquires samples continuously until you call the niRFSA_Abort function to abort the acquisition.
samplesPerRecord ViInt64 Specifies the number of samples per record if numberOfSamplesIsFinite is set to VI_TRUE.

Return Value

Name Type Description
status ViStatus 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 NI-RFSA 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 niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function.

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