niRFSA_ConfigureNumberOfRecords
ViStatus = niRFSA_ConfigureNumberOfRecords( ViSession vi, ViConstString channelList, ViBoolean numberOfRecordsIsFinite, ViInt64 numberOfRecords);
Purpose
Configures the number of records in a finite acquisition or configures the device to continuously acquire records. Notice that you can only configure the device to acquire multiple records if numberOfSamplesIsFinite is set to VI_TRUE.
If you configure the device to acquire records continuously, it continues acquiring records until you abort the acquisition. The device stores records in onboard memory in a circular fashion. Once the device fills the memory, it starts overwriting previously acquired records from the beginning of the memory buffer. Fetch the records 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. |
| numberOfRecordsIsFinite | ViBoolean | Set to VI_TRUE to configure the device to stop after acquiring the specified number of records. Set to VI_FALSE to acquire records continuously until you abort the acquisition. |
| numberOfRecords | ViInt64 | Specifies the number of records to acquire if number of records is finite 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 |