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 stops the acquisition. You can configure the device to acquire multiple records using the niRFSA_ConfigureNumberOfRecords function, each record containing the number of samples specified in this function. The default number of records to acquire is 1.
If the device is configured to continuously acquire samples, it continues acquiring data until you abort the acquisition. The device stores data in onboard memory in a circular fashion. Once the device fills the memory, it starts overwriting previously acquired data from the beginning of the memory buffer. Retrieve the samples using the niRFSA fetch IQ functions as they are being acquired to avoid data being overwritten before you can retrieve it.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or the niRFSA_initWithOptions functions and identifies a particular instrument session. |
| channelList | ViConstString | Identifies channels to apply settings. Use "" or VI_NULL to specify all channels. |
| numberOfSamplesIsFinite | ViBoolean | Specifies whether to configure the device to acquire a finite number of samples or to acquire samples continuously. VI_TRUE indicates that the device acquires a finite number of samples, while VI_FALSE indicates that the device continuously acquires samples. |
| 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. You examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the status code, call the niRFSA_error_message function. To obtain additional information about the error condition, call the niRFSA_GetError function. To clear the error information from the driver, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
Meaning | |
|---|---|---|---|---|
| 0 | Success | |||
| Positive Values | Warnings | |||
| Negative Values | Errors |