NI RFSA Configuration Functions

Configuration Functions

niRFSA_ConfigureAcquisitionType
niRFSA_ConfigureReferenceLevel
IQ
Spectrum
Trigger
niRFSA_GetTerminalName
Configuration List
Clock
De-embedding
Set/Get/Reset Attribute

niRFSA_ConfigureAcquisitionType

ViStatus niRFSA_ConfigureAcquisitionType(ViSession vi, ViInt32 acquisitionType);

Purpose

Configures whether the session acquires I/Q data or computes a power spectrum over the specified frequency range.

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

Related Topics

I/Q Modulation

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
acquisitionType	ViInt32	Configures the type of acquisition.

NIRFSA_VAL_IQ	Configures the driver for I/Q acquisitions. This value is the default.
NIRFSA_VAL_SPECTRUM	Configures the driver for spectrum acquisitions.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigureReferenceLevel

ViStatus niRFSA_ConfigureReferenceLevel(ViSession vi, ViConstString channelList, ViReal64 referenceLevel);

Purpose

Configures the reference level. The reference level represents the maximum expected power of an input RF signal.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5830/5831/5832/5840/5841

Related Topics

Improving Your Measurements

[Programming Attenuation-Related Properties and Attributes Using NI-RFSA](javascript:LaunchMergedHelp('nirfsa.chm', 'PXIe-5665.chm', 'programming-attenuation.html'))

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelList	ViConstString	Identifies which channels to apply settings. Specify an empty string as the value of this parameter.
referenceLevel	ViReal64	Specifies the expected total power, in dBm, of the RF input signal.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

IQ

niRFSA_ConfigureIQCarrierFrequency

ViStatus niRFSA_ConfigureIQCarrierFrequency(ViSession vi, ViConstString channelList, ViReal64 carrierFrequency);

Purpose

Configures the carrier frequency of the RF vector signal analyzer hardware for an I/Q acquisition. The carrier frequency is the center frequency of the I/Q acquisition.

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

Related Topics

Carrier Wave

I/Q Modulation

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelList	ViConstString	Identifies which channels to apply settings. Specify an empty string as the value of this parameter.
carrierFrequency	ViReal64	Specifies the carrier frequency, in hertz (Hz), of the RF signal to acquire. The RF vector signal analyzer tunes to this frequency. NI-RFSA may coerce this value based on hardware settings and downconversion settings. NI-RFSA sets the NIRFSA_ATTR_IQ_CARRIER_FREQUENCY attribute to this value. Refer to the specifications document that shipped with your device for allowable frequency settings.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigureIQRate

ViStatus niRFSA_ConfigureIQRate(ViSession vi, ViConstString channelList, ViReal64 iqRate);

Purpose

Specifies the I/Q rate for the acquisition. The value is expressed in samples per second (S/s).

For the PXIe-5663/5663E/5665/5667/5668, when you set the [NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE.html')) attribute to NIRFSA_VAL_ONBOARD_CLOCK_STR, the digitizer bandwidth is greater than or equal to the coerced iqRate times 0.8. Actual signal bandwidth is limited for all supported devices by the anti-aliasing filter. Further device-specific limitations are as follows.

	Note For the PXIe-5663/5663E/5665/5667/5668, NI-RFSA enables dithering by default. The dither noise can appear in your passband and affect your measurements. Refer to the [NIRFSA_ATTR_DIGITIZER_DITHER_ENABLED](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_DIGITIZER_DITHER_ENABLED.html')) attribute for more information about dithering.

**PXI-5661—**You should not need to configure an iqRate higher than 25 megasamples per second (MS/s) because the PXI-5600 RF downconverter bandwidth is 20 MHz. If you configure a higher I/Q rate, you may see aliasing effects at negative frequencies because the IF frequency of the PXI-5600 RF downconverter is 15 MHz.
**PXIe-5663/5663E—**Maximum allowed instantaneous bandwidth depends on the I/Q carrier frequency you use. Refer to the PXIe-5601 RF Downconverter Overview for more information about instantaneous bandwidth.
**PXIe-5665—**Actual signal bandwidth is limited by the preselector and the combination of the chosen IF filter and anti-aliasing filter. Maximum allowed instantaneous bandwidth is independent of the downconverter center frequency for frequencies less than 3.6 GHz. At frequencies greater than 3.6 GHz, if your device supports the preselector (YIG-tuned filter) and you have enabled it for your application, the maximum allowed instantaneous bandwidth is limited to the instantaneous bandwidth of the preselector. Refer to the NI PXIe-5665 Specifications for more information about instantaneous bandwidth limits.
**PXIe-5667—**Actual signal bandwidth is limited by the preselector and the combination of the chosen IF filter and anti-aliasing filter. Maximum allowed instantaneous bandwidth depends on the downconverter center frequency you use. Refer to the NI PXIe-5667 Specifications for more information about instantaneous bandwidth limits.
**PXIe-5668—**Actual signal bandwidth is limited by the FPGA image that is downloaded upon opening the session to the PXIe-5624 digitizer. Maximum allowed instantaneous bandwidth depends on the downconverter center frequency you use. Refer to the PXIe-5668 Specifications for more information about instantaneous bandwidth limits.
**PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841—**Maximum allowed instantaneous bandwidth depends on the downconverter center frequency you use. Refer to the specifications document for your device for more information about instantaneous bandwidth limits.

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

Related Topics

I/Q Modulation

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelList	ViConstString	Identifies which channels to apply settings. Specify an empty string as the value of this parameter.
iqRate	ViReal64	Specifies the I/Q rate for the acquisition. The value is expressed in samples per second (S/s).

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ConfigureNumberOfRecords.html')) 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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_abort.html')) 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

Related Topics

I/Q Modulation

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) 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_TRUE	The device acquires a finite number of samples.
VI_FALSE	The device acquires samples continuously until you call the [niRFSA_Abort](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_abort.html')) 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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

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. You can only configure the device to acquire multiple records if you set the numberOfRecordsIsFinite parameter to VI_TRUE.

If you configure the device to continuously acquire samples, it continues acquiring data until you call the [niRFSA_Abort](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_abort.html')) 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.

To acquire more records than will fit into the device memory without continuously acquiring records, set the numberOfRecordsIsFinite parameter in this function to VI_TRUE and the [NIRFSA_ATTR_ALLOW_MORE_RECORDS_THAN_MEMORY](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ALLOW_MORE_RECORDS_THAN_MEMORY.html')) attribute to VI_TRUE.

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

Related Topics

I/Q Modulation

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelList	ViConstString	Identifies which channels to apply settings. Specify an empty string as the value of this parameter.
numberOfRecordsIsFinite	ViBoolean	Specifies whether to configure the device to acquire a finite number of records or to acquire records continuously. The default is VI_TRUE.

VI_TRUE	The device acquires a finite number of records.
VI_FALSE	The NI-RFSA device acquires records continuously until you call the [niRFSA_Abort](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_abort.html')) function to abort the acquisition.

| :- | :- | :- | |numberOfRecords|ViInt64|Specifies the number of records to acquire if numberOfRecordsIsFinite 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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

Spectrum

niRFSA_ConfigureSpectrumFrequencyCenterSpan

ViStatus niRFSA_ConfigureSpectrumFrequencyCenterSpan(ViSession vi, ViConstString channelList, ViReal64 centerFrequency, ViReal64 span);

Purpose

Configures the span and center frequency of the spectrum read by NI-RFSA. A spectrum acquisition consists of data surrounding the center frequency.

	Note If you configure the spectrum span to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you requested.

	Note For the PXIe-5663/5663E, NI-RFSA does not support multispan acquisitions from frequency ranges that correspond with different instantaneous bandwidths. For example, you cannot configure a multispan acquisition that acquires one span from 110 MHz to 120 MHz and a second from 120 MHz to 130 MHz because the bandwidths that correspond to each span are different (10 MHz and 20 MHz, respectively).
Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelList	ViConstString	Identifies which channels to apply settings. Specify an empty string as the value of this parameter.
centerFrequency	ViReal64	Specifies the center frequency in a spectrum acquisition. The value is expressed in hertz (Hz). The NI-RFSA device you use determines the valid range. Refer to your device specifications document for more information about frequency range.
span	ViReal64	Specifies the span of a spectrum acquisition. The value is expressed in hertz (Hz).

	Note For the PXIe-5663/5663E/5665/5667/5668, NI-RFSA enables dithering by default. The dither noise can appear in your passband and affect your measurements. Refer to the [NIRFSA_ATTR_DIGITIZER_DITHER_ENABLED](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_DIGITIZER_DITHER_ENABLED.html')) attribute for more information about dithering.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigureSpectrumFrequencyStartStop

ViStatus niRFSA_ConfigureSpectrumFrequencyStartStop(ViSession vi, ViConstString channelList, ViReal64 startFrequency, ViReal64 stopFrequency);

Purpose

Configures the start and stop frequencies of a spectrum read by NI-RFSA.

	Note If you configure the spectrum span (stopFrequency – startFrequency) to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you request.

	Note For the PXIe-5663/5663E, NI-RFSA does not support multispan acquisitions from frequency ranges that correspond with different instantaneous bandwidths. For example, you cannot configure a multispan acquisition that acquires one span from 110 MHz to 120 MHz and a second from 120 MHz to 130 MHz because the bandwidths that correspond to each span are different (10 MHz and 20 MHz, respectively).
Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelList	ViConstString	Identifies which channels to apply settings. Specify an empty string as the value of this parameter.
startFrequency	ViReal64	Specifies the lower limit of a span of frequencies. This value is expressed in hertz (Hz).
stopFrequency	ViReal64	Specifies the upper limit of a span of frequencies. This value is expressed in hertz (Hz).

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigureResolutionBandwidth

ViStatus niRFSA_ConfigureResolutionBandwidth(ViSession vi, ViConstString channelList, ViReal64 resolutionBandwidth);

Purpose

Configures the resolution bandwidth of a spectrum acquisition. The resolution bandwidth controls the width of the frequency bins in the power spectrum computed by NI-RFSA. A larger value for resolution bandwidth means the frequency bins are wider, so you get fewer bins, or spectral lines.

By default, the resolution bandwidth value corresponds to the 3 decibels (dB) bandwidth of the window type NI-RFSA uses to compute the spectrum. To directly specify the frequency bin width, set the [NIRFSA_ATTR_RESOLUTION_BANDWIDTH_TYPE](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_RESOLUTION_BANDWIDTH_TYPE.html')) attribute to NIRFSA_VAL_BIN_WIDTH.

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

Related Topics

Resolution Bandwidth

Improving Your Measurements

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelList	ViConstString	Identifies which channels to apply settings. Specify an empty string as the value of this parameter.
resolutionBandwidth	ViReal64	Specifies the resolution bandwidth of a spectrum acquisition. The value is expressed in hertz (Hz). Configure the type of resolution bandwidth with the NIRFSA_ATTR_RESOLUTION_BANDWIDTH_TYPE attribute.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

Trigger

Start Trigger

niRFSA_ConfigureDigitalEdgeStartTrigger

ViStatus niRFSA_ConfigureDigitalEdgeStartTrigger(ViSession vi, ViConstString source, ViInt32 edge);

Purpose

Configures the device to wait for a digital edge Start Trigger at the beginning of the acquisition.

You can use this trigger with the [NI-TClk API](javascript:LaunchMergedHelp('nirfsa.chm', 'nitclk.chm', 'NI_TClk_Help.html')).

	Note The PXIe-5644/5645/5646 does not support the NI-TClk API.

	Note This function is not supported if you set the acquisitionType parameter to NIRFSA_VAL_SPECTRUM using the [niRFSA_ConfigureAcquisitionType](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ConfigureAcquisitionType.html')) function or if you set the [NIRFSA_ATTR_ACQUISITION_TYPE](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACQUISITION_TYPE.html')) attribute to NIRFSA_VAL_SPECTRUM.
Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Triggers

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
source	ViConstString	Specifies the source of the digital edge for the Start Trigger.

NIRFSA_VAL_PFI0_STR ("PFI0")	The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.
NIRFSA_VAL_PFI1_STR ("PFI1")	The trigger is received on PFI 1.
NIRFSA_VAL_PXI_TRIG0_STR ("PXI_Trig0")	The trigger is received on PXI trigger line 0.
NIRFSA_VAL_PXI_TRIG1_STR ("PXI_Trig1")	The trigger is received on PXI trigger line 1.
NIRFSA_VAL_PXI_TRIG2_STR ("PXI_Trig2")	The trigger is received on PXI trigger line 2.
NIRFSA_VAL_PXI_TRIG3_STR ("PXI_Trig3")	The trigger is received on PXI trigger line 3.
NIRFSA_VAL_PXI_TRIG4_STR ("PXI_Trig4")	The trigger is received on PXI trigger line 4.
NIRFSA_VAL_PXI_TRIG5_STR ("PXI_Trig5")	The trigger is received on PXI trigger line 5.
NIRFSA_VAL_PXI_TRIG6_STR ("PXI_Trig6")	The trigger is received on PXI trigger line 6.
NIRFSA_VAL_PXI_TRIG7_STR ("PXI_Trig7")	The trigger is received on PXI trigger line 7.
NIRFSA_VAL_PXI_STAR_STR ("PXI_STAR")	The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices.
NIRFSA_VAL_PXIE_DSTARB_STR ("PXIE_DSTARB")	The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.
NIRFSA_VAL_TIMER_EVENT_STR ("TimerEvent")	The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5840/5841 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665.

| :- | :- | :- | |edge|ViInt32|Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.|

NIRFSA_VAL_RISING_EDGE (900)	NI-RFSA detects a rising edge.
NIRFSA_VAL_FALLING_EDGE (901)	NI-RFSA detects a falling edge.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigureSoftwareEdgeStartTrigger

ViStatus niRFSA_ConfigureSoftwareEdgeStartTrigger(ViSession vi);

Purpose

Configures the device to wait for a software Start Trigger at the beginning of the acquisition. The device waits until you call the [niRFSA_SendSoftwareEdgeTrigger](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_SendSoftwareEdgeTrigger.html')) function to assert the trigger.

You can use this trigger with the [NI-TClk API](javascript:LaunchMergedHelp('nirfsa.chm', 'nitclk.chm', 'NI_TClk_Help.html')).

	Note The PXIe-5644/5645/5646 does not support the NI-TClk API.

	Note This function is not supported if you set the acquisitionType parameter to NIRFSA_VAL_SPECTRUM using the [niRFSA_ConfigureAcquisitionType](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ConfigureAcquisitionType.html')) function or if you set the [NIRFSA_ATTR_ACQUISITION_TYPE](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACQUISITION_TYPE.html')) attribute to NIRFSA_VAL_SPECTRUM.
Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Triggers

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_DisableStartTrigger

ViStatus niRFSA_DisableStartTrigger(ViSession vi);

Purpose

Configures the device to not wait for a Start Trigger at the beginning of the acquisition. This function is necessary only if you previously configured a Start Trigger in the past and now want to disable it.

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

Related Topics

Triggers

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

Ref Trigger

niRFSA_ConfigureDigitalEdgeRefTrigger

ViStatus niRFSA_ConfigureDigitalEdgeRefTrigger(ViSession vi, ViConstString source, ViInt32 edge, ViInt64 pretriggerSamples);

Purpose

Configures the device to wait for a digital edge Reference Trigger to mark a reference point within the record.

You can use this trigger with the [NI-TClk API](javascript:LaunchMergedHelp('nirfsa.chm', 'nitclk.chm', 'NI_TClk_Help.html')).

	Note The PXIe-5644/5645/5646 does not support the NI-TClk API.

	Note This function is not supported if you set the acquisitionType parameter to NIRFSA_VAL_SPECTRUM using the [niRFSA_ConfigureAcquisitionType](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ConfigureAcquisitionType.html')) function or if you set the [NIRFSA_ATTR_ACQUISITION_TYPE](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACQUISITION_TYPE.html')) attribute to NIRFSA_VAL_SPECTRUM.
Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Triggers

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
source	ViConstString	Specifies the source of the digital edge for the Reference trigger.

NIRFSA_VAL_PFI0_STR ("PFI0")	The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.
NIRFSA_VAL_PFI1_STR ("PFI1")	The trigger is received on PFI 1.
NIRFSA_VAL_PXI_TRIG0_STR ("PXI_Trig0")	The trigger is received on PXI trigger line 0.
NIRFSA_VAL_PXI_TRIG1_STR ("PXI_Trig1")	The trigger is received on PXI trigger line 1.
NIRFSA_VAL_PXI_TRIG2_STR ("PXI_Trig2")	The trigger is received on PXI trigger line 2.
NIRFSA_VAL_PXI_TRIG3_STR ("PXI_Trig3")	The trigger is received on PXI trigger line 3.
NIRFSA_VAL_PXI_TRIG4_STR ("PXI_Trig4")	The trigger is received on PXI trigger line 4.
NIRFSA_VAL_PXI_TRIG5_STR ("PXI_Trig5")	The trigger is received on PXI trigger line 5.
NIRFSA_VAL_PXI_TRIG6_STR ("PXI_Trig6")	The trigger is received on PXI trigger line 6.
NIRFSA_VAL_PXI_TRIG7_STR ("PXI_Trig7")	The trigger is received on PXI trigger line 7.
NIRFSA_VAL_PXI_STAR_STR ("PXI_STAR")	The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices.
NIRFSA_VAL_PXIE_DSTARB_STR ("PXIE_DSTARB")	The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.
NIRFSA_VAL_TIMER_EVENT_STR ("TimerEvent")	The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665.

| :- | :- | :- | |edge|ViInt32|Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.|

NIRFSA_VAL_RISING_EDGE (900)	NI-RFSA detects a rising edge.
NIRFSA_VAL_FALLING_EDGE (901)	NI-RFSA detects a falling edge.

| :- | :- | :- | |pretriggerSamples|ViInt64|Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred. |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigureIQPowerEdgeRefTrigger

ViStatus niRFSA_ConfigureIQPowerEdgeRefTrigger(ViSession vi, ViConstString source, ViReal64 level, ViInt32 slope, ViInt64 pretriggerSamples);

Purpose

Configures the device to wait for the complex power of the I/Q data to cross the specified threshold to mark a reference point within the record.

To trigger on burst signals, add a minimum quiet time, configured with the [NIRFSA_ATTR_REF_TRIGGER_MINIMUM_QUIET_TIME](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_REF_TRIGGER_MINIMUM_QUIET_TIME.html')) attribute, to ensure the trigger does not occur in the middle of a burst if the acquisition starts while a burst is being generated. The quiet time should be set to a value smaller than the time between bursts, but large enough to ignore power changes within a burst.

You can use this trigger with the [NI-TClk API](javascript:LaunchMergedHelp('nirfsa.chm', 'nitclk.chm', 'NI_TClk_Help.html')).

	Note This function is not supported if you set the acquisitionType parameter to NIRFSA_VAL_SPECTRUM using the [niRFSA_ConfigureAcquisitionType](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ConfigureAcquisitionType.html')) function or if you set the [NIRFSA_ATTR_ACQUISITION_TYPE](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACQUISITION_TYPE.html')) attribute to NIRFSA_VAL_SPECTRUM.
Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Triggers

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
source	ViConstString	Specifies the source of the RF signal for the power edge Reference trigger. The only supported value is "0".
level	ViReal64	Specifies the threshold, in dBm, above or below which the device triggers.
slope	ViInt32	Specifies whether the device detects a positive or negative slope on the trigger signal. The default value is NIRFSA_VAL_RISING_SLOPE.

NIRFSA_VAL_RISING_SLOPE (1000)	NI-RFSA detects a rising edge (positive slope).
NIRFSA_VAL_FALLING_SLOPE (1001)	NI-RFSA detects a falling edge (negative slope).

| :- | :- | :- | |pretriggerSamples|ViInt64|Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred. |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigureSoftwareEdgeRefTrigger

ViStatus niRFSA_ConfigureSoftwareEdgeRefTrigger(ViSession vi, ViInt64 pretriggerSamples);

Purpose

Configures the device to wait for a software Reference Trigger to mark a reference point within the record. The device waits until you call the [niRFSA_SendSoftwareEdgeTrigger](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_SendSoftwareEdgeTrigger.html')) function to assert the trigger.

You can use this trigger with the [NI-TClk API](javascript:LaunchMergedHelp('nirfsa.chm', 'nitclk.chm', 'NI_TClk_Help.html')).

	Note The PXIe-5644/5645/5646 does not support the NI-TClk API.

	Note This function is not supported if you set the acquisitionType parameter to NIRFSA_VAL_SPECTRUM using the [niRFSA_ConfigureAcquisitionType](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ConfigureAcquisitionType.html')) function or if you set the [NIRFSA_ATTR_ACQUISITION_TYPE](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACQUISITION_TYPE.html')) attribute to NIRFSA_VAL_SPECTRUM.
Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Triggers

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
pretriggerSamples	ViInt64	Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_DisableRefTrigger

ViStatus niRFSA_DisableRefTrigger(ViSession vi);

Purpose

Configures the device to not wait for a Reference Trigger to mark a reference point within a record. This function is necessary only if you previously configured a Reference trigger in the past and now want to disable it.

Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5668, PXIe-5820/5840/5841

Related Topics

Triggers

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

Advance Trigger

niRFSA_ConfigureDigitalEdgeAdvanceTrigger

ViStatus niRFSA_ConfigureDigitalEdgeAdvanceTrigger(ViSession vi, ViConstString source, ViInt32 edge);

Purpose

Configures the device to wait for a digital edge Advance Trigger. The Advance Trigger indicates where a new record begins.

	Note This function is not supported if you set the acquisitionType parameter to NIRFSA_VAL_SPECTRUM using the [niRFSA_ConfigureAcquisitionType](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ConfigureAcquisitionType.html')) function or if you set the [NIRFSA_ATTR_ACQUISITION_TYPE](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACQUISITION_TYPE.html')) attribute to NIRFSA_VAL_SPECTRUM.
Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Triggers

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
source	ViConstString	Specifies the source of the digital edge for the Advance Trigger.

NIRFSA_VAL_PFI0_STR ("PFI0")	The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.
NIRFSA_VAL_PFI1_STR ("PFI1")	The trigger is received on PFI 1.
NIRFSA_VAL_PXI_TRIG0_STR ("PXI_Trig0")	The trigger is received on PXI trigger line 0.
NIRFSA_VAL_PXI_TRIG1_STR ("PXI_Trig1")	The trigger is received on PXI trigger line 1.
NIRFSA_VAL_PXI_TRIG2_STR ("PXI_Trig2")	The trigger is received on PXI trigger line 2.
NIRFSA_VAL_PXI_TRIG3_STR ("PXI_Trig3")	The trigger is received on PXI trigger line 3.
NIRFSA_VAL_PXI_TRIG4_STR ("PXI_Trig4")	The trigger is received on PXI trigger line 4.
NIRFSA_VAL_PXI_TRIG5_STR ("PXI_Trig5")	The trigger is received on PXI trigger line 5.
NIRFSA_VAL_PXI_TRIG6_STR ("PXI_Trig6")	The trigger is received on PXI trigger line 6.
NIRFSA_VAL_PXI_TRIG7_STR ("PXI_Trig7")	The trigger is received on PXI trigger line 7.
NIRFSA_VAL_PXI_STAR_STR ("PXI_STAR")	The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices.
NIRFSA_VAL_PXIE_DSTARB_STR ("PXIE_DSTARB")	The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.
NIRFSA_VAL_TIMER_EVENT_STR ("TimerEvent")	The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5840/5841 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665.

| :- | :- | :- | |edge|ViInt32|Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.|

NIRFSA_VAL_RISING_EDGE (900)	NI-RFSA detects a rising edge.
NIRFSA_VAL_FALLING_EDGE (901)	NI-RFSA detects a falling edge.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigureSoftwareEdgeAdvanceTrigger

ViStatus niRFSA_ConfigureSoftwareEdgeAdvanceTrigger(ViSession vi);

Purpose

Configures the device to wait for a software Advance Trigger. The Advance Trigger indicates where a new record begins. The device waits until you call the [niRFSA_SendSoftwareEdgeTrigger](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_SendSoftwareEdgeTrigger.html')) function to assert the trigger.

	Note This function is not supported if you set the acquisitionType parameter to NIRFSA_VAL_SPECTRUM using the [niRFSA_ConfigureAcquisitionType](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ConfigureAcquisitionType.html')) function or if you set the [NIRFSA_ATTR_ACQUISITION_TYPE](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACQUISITION_TYPE.html')) attribute to NIRFSA_VAL_SPECTRUM.
Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Triggers

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_DisableAdvanceTrigger

ViStatus niRFSA_DisableAdvanceTrigger(ViSession vi);

Purpose

Configures the device to not use an Advance Trigger. This function is necessary only if you configured an Advance Trigger in the past and now want to disable it.

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

Related Topics

Triggers

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_SendSoftwareEdgeTrigger

ViStatus niRFSA_SendSoftwareEdgeTrigger(ViSession vi, ViInt32 trigger, ViConstString triggerIdentifier);

Purpose

Sends a trigger to the device when you use a software version of a supported trigger and the device is waiting for the trigger to be sent. You can also use this function to override a hardware trigger.

This function returns an error in the following situations:

You configure an invalid trigger.
You set the acquisitionType to NIRFSA_VAL_SPECTRUM using the [niRFSA_ConfigureAcquisitionType](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ConfigureAcquisitionType.html')) function.
You have not previously called the [niRFSA_Initiate](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_Initiate.html')) function.

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

Related Topics

Software Trigger

Triggers

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
trigger	ViInt32	Specifies the software signal to send.

NIRFSA_VAL_START_TRIGGER (1100)	NI-RFSA sends a Start software trigger.
NIRFSA_VAL_REF_TRIGGER (702)	NI-RFSA sends a Reference software trigger.
NIRFSA_VAL_ADVANCE_TRIGGER (1102)	NI-RFSA sends an Advance software trigger.
NIRFSA_VAL_ARM_REF_TRIGGER (1103)	NI-RFSA sends an Arm Reference software trigger. This trigger is not valid for the PXIe-5668.

| :- | :- | :- | |triggerIdentifier|ViConstString|Specifies a particular instance of a trigger. NI-RFSA does not currently support this parameter.|

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ExportSignal

ViStatus niRFSA_ExportSignal(ViSession vi, ViInt32 signal, ViConstString signalIdentifier, ViConstString outputTerminal);

Purpose

Routes signals (triggers, clocks, and events) to the specified output terminal.

If you export a signal with this function and [commit](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_Commit.html')) the session, the signal is routed to the output terminal you specify. If you then reconfigure the signal to have a different output terminal, the previous output terminal is tri-stated when the session is next committed. If you set the outputTerminal parameter to NIRFSA_VAL_DO_NOT_EXPORT and commit, the previous output terminal is tristated.

Any signals, except for those exported over PXI trigger lines, that are exported within a session persist after the session closes to prevent signal glitches between sessions. PXI trigger lines are always set to tristate when a session is closed. If you wish to have the output terminal tristated when the session closes, change the outputTerminal for the exported signal to NIRFSA_VAL_DO_NOT_EXPORT, and commit the session again before closing it.

You can also tristate all PFI lines by setting the resetDevice parameter in the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) function to VI_TRUE or by using the [niRFSA_reset](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_reset.html')) function.

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

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
signal	ViInt32	Specifies the type of signal to route.

NIRFSA_VAL_START_TRIGGER (1100)	NI-RFSA routes a Start Trigger.
NIRFSA_VAL_REF_TRIGGER (702)	NI-RFSA routes a Reference trigger.
NIRFSA_VAL_ADVANCE_TRIGGER (1102)	NI-RFSA routes an Advance Trigger.
NIRFSA_VAL_READY_FOR_START_EVENT (1200)	NI-RFSA routes a Ready for Start Event.
NIRFSA_VAL_READY_FOR_ADVANCE_EVENT (1202)	NI-RFSA routes a Ready for Advance Event.
NIRFSA_VAL_READY_FOR_REF_EVENT (1201)	NI-RFSA routes a Ready for Reference Event.
NIRFSA_VAL_END_OF_RECORD_EVENT (1203)	NI-RFSA routes an End of Record Event.
NIRFSA_VAL_DONE_EVENT (1204)	NI-RFSA routes a Done Event.
NIRFSA_VAL_REF_CLOCK (1205)	NI-RFSA routes a Reference Clock signal.
NIRFSA_VAL_USER (1206)	NI-RFSA routes a user-defined signal, specified using the signalIdentifier parameter.

NIRFSA_VAL_DO_NOT_EXPORT_STR	The signal is not exported.
NIRFSA_VAL_CLK_OUT_STR	The signal is exported to the CLK OUT connector on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.
NIRFSA_VAL_REF_OUT_STR	The signal is exported to the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5694, PXIe-5644/5645/5646, or PXIe-5820/5830/5831/5832/5840/5841.
NIRFSA_REF_OUT2_STR	The signal is exported to the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.
NIRFSA_VAL_PFI0_STR	The signal is exported to the PFI 0 connector.
NIRFSA_VAL_PFI1_STR	The signal is exported to the PFI 1 connector on the PXI-5142 and PXIe-5622.
NIRFSA_VAL_PXI_TRIG0_STR	The signal is exported to the PXI trigger line 0.
NIRFSA_VAL_PXI_TRIG1_STR	The signal is exported to the PXI trigger line 1.
NIRFSA_VAL_PXI_TRIG2_STR	The signal is exported to the PXI trigger line 2.
NIRFSA_VAL_PXI_TRIG3_STR	The signal is exported to the PXI trigger line 3.
NIRFSA_VAL_PXI_TRIG4_STR	The signal is exported to the PXI trigger line 4.
NIRFSA_VAL_PXI_TRIG5_STR	The signal is exported to the PXI trigger line 5.
NIRFSA_VAL_PXI_TRIG6_STR	The signal is exported to the PXI trigger line 6.
NIRFSA_VAL_PXI_TRIG7_STR	The signal is exported to the PXI trigger line 7.
NIRFSA_VAL_PXI_STAR_STR	The signal is exported to the PXI star trigger line.
NIRFSA_VAL_PXIE_DSTARC_STR	The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_GetTerminalName

ViStatus niRFSA_GetTerminalName(ViSession vi, ViInt32 signal, ViConstString signalIdentifier, ViInt32 bufferSize, ViChar terminalName[]);

Purpose

Returns the fully qualified name of the signal being queried. Signals can be triggers, clocks, or events.

You can pass the terminalName parameter that is returned to the source parameter of a configure trigger function.

Supported Devices: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Events

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
signal	ViInt32	Specifies the signal for which you want to query the terminal.

NIRFSA_VAL_START_TRIGGER (1100)	NI-RFSA returns the terminal name for the Start Trigger.
NIRFSA_VAL_REF_TRIGGER (702)	NI-RFSA returns the terminal name for the Reference trigger.
NIRFSA_VAL_ADVANCE_TRIGGER (1102)	NI-RFSA returns the terminal name for the Advance Trigger.
NIRFSA_VAL_READY_FOR_START_EVENT (1200)	NI-RFSA returns the terminal name for the Ready for Start Event.
NIRFSA_VAL_READY_FOR_ADVANCE_EVENT (1202)	NI-RFSA returns the terminal name for the Ready for Advance Event.
NIRFSA_VAL_READY_FOR_REF_EVENT (1201)	NI-RFSA returns the terminal name for the Ready for Reference Event.
NIRFSA_VAL_END_OF_RECORD_EVENT (1203)	NI-RFSA returns the terminal name for the End of Record Event.
NIRFSA_VAL_DONE_EVENT (1204)	NI-RFSA returns the terminal name for the Done Event.
NIRFSA_VAL_REF_CLOCK (1205)	NI-RFSA does not support this option for the niRFSA_GetTerminalName function.

| :- | :- | :- | |signalIdentifier|ViConstString|Specifies a particular instance of a trigger. NI-RFSA does not support this parameter.| |bufferSize|ViInt32|Passes the number of bytes in the ViChar buffer that you allocate for the terminalName parameter. | |Output||| |Name|Type|Description| |terminalName|ViChar[]|Returns the fully qualified name of the signal being queried.|

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

Configuration List

niRFSA_CreateConfigurationList

ViStatus niRFSA_CreateConfigurationList (ViSession vi, ViConstString listName, ViInt32 numberOfListAttributes, const ViAttr* listAttributeIDs, ViBoolean setAsActiveList);

Purpose

Creates an empty configuration list for RF list mode. After a configuration list is created, enable the list using the setAsActiveList parameter. Call the [niRFSA_CreateConfigurationListStep](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_CreateConfigurationListStep.html')) function to add steps to the active configuration list.

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

Related Topics

RF List Mode

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
listName	ViConstString	Specifies the name of the configuration list. This string may not contain spaces, special characters, or punctuation marks.
numberOfListAttributes	ViInt32	Specifies the number of configuration list attributes to set.
listAttributeIDs	const ViAttr*	Specifies the attributes that you intend to change between configuration list steps. Calling the niRFSA_CreateConfigurationList function allocates space for each of the configuration list properties. When you use set one of the configuration list attributes, that attribute is set as one of the configuration list steps. Specify which configuration list step is being configured using the [NIRFSA_ATTR_ACTIVE_CONFIGURATION_LIST](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACTIVE_CONFIGURATION_LIST.html')) attribute. You can include the following attributes in your configuration list based on your device:

Attribute	PXIe-5663E	PXIe-5665	PXIe-5667	PXIe-5644/5646	PXIe-5645	PXIe-5820	PXIe-5830/5831/5832	PXIe-5840/5841
[NIRFSA_ATTR_CHANNEL_COUPLING](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_CHANNEL_COUPLING.html'))			✓
[NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH.html'))	✓	✓	✓			✓		✓
[NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY.html'))	✓	✓	✓	✓	✓			✓
[NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY_OFFSET](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_DOWNCONVERTER_FREQUENCY_OFFSET.html'))	✓	✓	✓	✓	✓			✓
[NIRFSA_ATTR_DOWNCONVERTER_PRESELECTOR_ENABLED](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_PRESELECTOR_ENABLED.html'))		✓ (PXIe-5665 (14 GHz) only)	✓ (PXIe-5667 (7 GHz) only)					✓
[NIRFSA_ATTR_EXTERNAL_GAIN](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_EXTERNAL_GAIN.html'))	✓	✓	✓			✓	✓	✓
[NIRFSA_ATTR_FREQUENCY_SETTLING](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_FREQUENCY_SETTLING.html'))	✓	✓	✓					✓
[NIRFSA_ATTR_IF_FILTER_BANDWIDTH](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_IF_FILTER_BANDWIDTH.html'))	✓	✓	✓
[NIRFSA_ATTR_IF_OUTPUT_POWER_LEVEL](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_IF_OUTPUT_POWER_LEVEL.html'))	✓	✓	✓
[NIRFSA_ATTR_IF_OUTPUT_POWER_LEVEL_OFFSET](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_IF_OUTPUT_POWER_LEVEL_OFFSET.html'))	✓	✓	✓
[NIRFSA_ATTR_IQ_CARRIER_FREQUENCY](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_IQ_CARRIER_FREQUENCY.html'))	✓	✓	✓	✓	✓	✓		✓
[NIRFSA_ATTR_IQ_IN_PORT_CARRIER_FREQUENCY](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_IQ_IN_PORT_CARRIER_FREQUENCY.html'))					✓	✓
[NIRFSA_ATTR_IQ_IN_PORT_VERTICAL_RANGE](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_IQ_IN_PORT_VERTICAL_RANGE.html'))					✓	✓
[NIRFSA_ATTR_IQ_POWER_EDGE_REF_TRIGGER_LEVEL](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_IQ_POWER_EDGE_REF_TRIGGER_LEVEL.html'))	✓	✓	✓	✓	✓	✓	✓	✓
[NIRFSA_ATTR_LOW_FREQUENCY_BYPASS_ENABLED](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_LOW_FREQUENCY_BYPASS_ENABLED.html'))			✓
[NIRFSA_ATTR_MECHANICAL_ATTENUATION](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_MECHANICAL_ATTENUATION.html'))	✓	✓	✓
[NIRFSA_ATTR_MECHANICAL_ATTENUATOR_ENABLED](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_MECHANICAL_ATTENUATOR_ENABLED.html'))	✓
[NIRFSA_ATTR_MINIMUM_ACPR](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_MINIMUM_ACPR.html'))		✓
[NIRFSA_ATTR_NOTCH_FILTER_ENABLED](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_NOTCH_FILTER_ENABLED.html'))			✓
[NIRFSA_ATTR_NUMBER_OF_SAMPLES](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_NUM_SAMPLES.html'))						✓	✓	✓
[NIRFSA_ATTR_OSP_DATA_SCALING_FACTOR](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_OSP_DATA_SCALING_FACTOR.html'))	✓	✓	✓			✓	✓	✓
[NIRFSA_ATTR_REFERENCE_LEVEL](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_REFERENCE_LEVEL.html'))	✓	✓	✓	✓	✓		✓	✓
[NIRFSA_ATTR_ATTENUATION](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ATTENUATION.html'))	✓	✓	✓
[NIRFSA_ATTR_RF_PREAMP_ENABLED](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_RF_PREAMP_ENABLED.html'))	✓	✓	✓					✓
[NIRFSA_ATTR_RF_PRESELECTOR_FILTER](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_RF_PRESELECTOR_FILTER.html'))			✓
[NIRFSA_ATTR_SELECTED_PORTS](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_SELECTED_PORTS.html'))							✓
[NIRFSA_ATTR_TIMER_EVENT_INTERVAL](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_TIMER_EVENT_INTERVAL.html'))	✓	✓	✓	✓	✓	✓	✓	✓

| :- | :- | :- | |setAsActiveList|ViBoolean|Sets this list as the active configuration list when this parameter 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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_CreateConfigurationListStep

ViStatus niRFSA_CreateConfigurationListStep (ViSession vi, ViBoolean setAsActiveStep);

Purpose

Creates a new configuration list step in the configuration list for RF list mode specified by the [NIRFSA_ATTR_ACTIVE_CONFIGURATION_LIST](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACTIVE_CONFIGURATION_LIST.html')) attribute. When you create a configuration list step, a new instance of each attribute specified by the configuration list attributes is created. Configuration list attributes are specified when a configuration list is created.

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

Related Topics

RF List Mode

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
setAsActiveStep	ViBoolean	Sets this step as the active step for the active configuration list. The default value for this parameter is VI_TRUE. If you set this parameter to VI_FALSE, you can select the active configuration list step using the [NIRFSA_ATTR_ACTIVE_CONFIGURATION_LIST_STEP](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACTIVE_STEP.html')) attribute.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_DeleteConfigurationList

ViStatus niRFSA_DeleteConfigurationList(ViSession vi, ViConstString listName);

Purpose

Deletes a previously created configuration list and all the configuration list steps in the RF list mode configuration list. When a configuration list step is deleted, all the instances of the attributes associated with the configuration list step are also removed. When you delete the active configuration list, NI-RFSA automatically resets the [NIRFSA_ATTR_ACTIVE_CONFIGURATION_LIST](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACTIVE_CONFIGURATION_LIST.html')) attribute to "" (empty string), which indicates no list is active, and the [NIRFSA_ATTR_ACTIVE_CONFIGURATION_LIST_STEP](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'NIRFSA_ATTR_ACTIVE_STEP.html')) attribute to 0.

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

Related Topics

RF List Mode

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
listName	ViConstString	Specifies the name of the configuration list. This string may not contain spaces, special characters, or punctuation marks.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

Clock

niRFSA_ConfigureRefClock

ViStatus niRFSA_ConfigureRefClock(ViSession vi, ViConstString clockSource, ViReal64 refClockRate);

Purpose

Configures the NI-RFSA device Reference Clock.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

PXI-5661 Reference Clock

PXIe-5663 Timing Configurations

PXIe-5665 Timing Configurations

PXIe-5667 Timing Configurations

PXIe-5668 Timing Configurations

[PXIe-5830 Timing Configurations](javascript:LaunchMergedHelp('nirfsa.chm', 'PXIe-5830.chm', 'timing-configurations.html'))

[PXIe-5831 Timing Configurations](javascript:LaunchMergedHelp('nirfsa.chm', 'PXIe-5831.chm', 'timing-configurations.html'))

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
clockSource	ViConstString	Specifies the Reference Clock source.

NIRFSA_VAL_ONBOARD_CLOCK_STR ("OnboardClock")	PXI-5661—NI-RFSA locks the NI-RFSA device to the PXI-5600 RF downconverter onboard clock. PXIe-5663/5663E—NI-RFSA locks the PXIe-5663/5663E to the PXI/PXIe-5652 LO source onboard clock. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, connect the REF IN/OUT connector on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. PXIe-5665—NI-RFSA locks the PXIe-5665 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622. PXIe-5667—NI-RFSA locks the PXIe-5667 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694. PXIe-5668—Lock the PXIe-5668 to the PXIe-5653 LO source onboard clock. Connect the LO2 OUT terminal on the PXIe-5606 to the CLK IN connector on the PXIe-5624. PXIe-5644/5645/5646, PXIe-5820/5840/5841—Lock the NI-RFSA device to its onboard clock. PXIe-5830/5831/5832—For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5832, connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. PXIe-5831 with PXIe-5653—Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. PXIe-5832 with PXIe-5653—Connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3623 REF IN connector. PXIe-5840 with PXIe-5653—Lock to the PXIe-5653 onboard clock. Connect the REF OUT (10 MHz) connector on the PXIe-5653 to the PXIe-5840 REF IN connector. Configure open NI-RFSG sessions to the device to use NIRFSG_VAL_REF_IN_STR for the PXIe-5840 or NIRFSG_VAL_REF_IN_2_STR for the PXIe-5840 with PXIe-5653. PXIe-5841 with PXIe-5655—Lock to the PXIe-5655 onboard clock. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector.
NIRFSA_VAL_REF_IN_STR ("RefIn")	PXI-5661—NI-RFSA locks the NI-RFSA device to the signal at the external FREQ REF IN connector on the PXI-5600. PXIe-5663/5663E—Connect the external signal to the PXI/PXIe-5652 REF IN/OUT connector. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN connector on the PXIe-5622. On versions of the 5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, this configuration can only be used in external digitizer mode. PXIe-5665—NI-RFSA locks the PXIe-5665 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN connector on the PXIe-5622. If your external clock signal frequency is set to a frequency other than 10 MHz, set the refClockRate parameter according to the frequency of your external clock signal. PXIe-5667—NI-RFSA locks the PXIe-5667 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN connector on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694. If your external clock signal frequency is set to a frequency other than 10 MHz, set the refClockRate parameter according to the frequency of your external clock signal. PXIe-5668—Connect the external signal to the PXIe-5653 REF IN connector. Connect the LO2 OUT terminal on the PXIe-5606 to the CLK IN connector on the PXIe-5624. If your external clock signal frequency is set to a frequency other than 10 MHz, set the clock rate parameter according to the frequency of your external clock signal. PXIe-5694—Connect the Reference Clock signal to the REF/LO IN connector on the PXIe-5694 front panel. PXIe-5644/5645/5646, PXIe-5820/5840/5841—Lock the NI-RFSA device to the signal at the external REF IN connector. PXIe-5830/5831/5832—For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5832, connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831, lock the external signal to the PXIe-3622 REF IN connector. For the PXIe-5832, lock the external signal to the PXIe-3623 REF IN connector. PXIe-5831 with PXIe-5653—Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. PXIe-5832 with PXIe-5653—Connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. PXIe-5840 with PXIe-5653—Lock to the signal at the REF IN connector on the associated PXIe-5653. Connect the REF OUT (10 MHz) connector on the PXIe-5653 to the PXIe-5840 REF IN connector. PXIe-5841 with PXIe-5655—Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the PXIe-5655 REF OUT connector to the PXIe-5841 REF IN connector.
NIRFSA_VAL_CLK_IN_STR ("ClkIn")	PXIe-5663/5663E—NI-RFSA locks the PXIe-5663/5663E to an external 10 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the FREQ REF IN connector on the PXI/PXIe-5652. PXIe-5665—NI-RFSA locks the PXIe-5665 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the refClockRate parameter to 100 MHz. PXIe-5667—NI-RFSA locks the PXIe-5667 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694. Set the refClockRate parameter to 100 MHz. PXIe-5668—Lock the PXIe-5668 to an external 10 MHz or 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5624, and connect the PXIe-5624 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the clock rate parameter to 10 MHz or 100 MHz, as appropriate. PXIe-5644/5645/5646, PXI-5661, PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5840/5840 with PXIe-5653/5841/5841 with PXIe-5655—This configuration does not apply.
NIRFSA_VAL_PXI_CLK_STR ("PXI_Clk")	PXI-5661—NI-RFSA locks the NI-RFSA device to the PXI backplane clock using the PXI-5600. You must connect the PXI 10 MHz connector to the FREQ REF IN connector on the PXI-5600 front panel to use this option. PXIe-5668—Lock the PXIe-5653 to the PXI backplane clock. Connect the PXIe-5606 LO2 OUT connector to the CLK IN connector on the PXIe-5624. PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667, PXIe-5694, PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5840/5840 with PXIe-5653/5841/5841 with PXIe-5655—NI-RFSA locks the device to the PXI backplane clock.
NIRFSA_VAL_REF_IN_2_STR ("RefIn2")	PXIe-5840 with PXIe-5653—NI-RFSA locks the device to the clock sourced at the PXIe-5840 REF IN terminal that is already configured by an NI-RFSG session. Connect the PXIe-5840 REF OUT connector to the PXIe-5653 REF IN connector. Configure open NI-RFSG sessions to use NIRFSG_VAL_REF_IN_STR for the PXIe-5840 or NIRFSG_VAL_ONBOARD_CLOCK_STR for the PXIe-5840 with PXIe-5653. PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5840/5841/5841 with PXIe-5655—This configuration does not apply.
NIRFSA_VAL_PXI_CLK_MASTER_STR ("PXI_ClkMaster")	PXIe-5831 with PXIe-5653—NI-RFSA configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use NIRFSA_VAL_PXI_CLK_STR as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector.	PXIe-5832 with PXIe-5653—NI-RFSA configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3623 to use NIRFSA_VAL_PXI_CLK_STR as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. PXIe-5840 with PXIe-5653—NI-RFSA configures the PXIe-5653 to export the Reference Clock, and configures the PXIe-5840 to use NIRFSA_VAL_PXI_CLK_STR. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. For best performance, configure all other devices in the system to use NIRFSA_VAL_PXI_CLK_STR as the Reference Clock source. PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5841 with PXIe-5655—This configuration does not apply.

| :- | :- | :- | |refClockRate|ViReal64|Specifies the Reference Clock rate, in Hz, of the signal present at the REF IN or CLK IN connector. This parameter is only valid when the clockSource parameter is set to NIRFSA_VAL_CLK_IN_STR, NIRFSA_VAL_REF_IN_STR, or NIRFSA_VAL_REF_IN_2_STR. The default is 10 MHz.

For the PXIe-5644/5645/5646, the PXIe-5601/5663, PXIe-5694, and the PXIe-5820/5830/5831/5832/5840/5841, 10 MHz is the only supported value.

For the PXIe-5603/5605/5665/5667/5668, you can specify values between 5 MHz and 100 MHz, in increments of 1 MHz.

For the PXIe-5841 with PXIe-5655, the following values are supported: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz * y, where y is 4, 8, 16, 24, 25, or 32. |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigurePXIChassisClk10

ViStatus niRFSA_ConfigurePXIChassisClk10(ViSession vi, ViConstString pxiClk10Source);

Purpose

Specifies the signal to drive the 10 MHz Reference Clock on the PXI backplane. This option can be configured only when the PXI-5600 is installed in the Star Trigger Controller Slot, also known as the System Timing Slot, of the PXI chassis.

Supported Devices: PXI-5600 (external digitizer mode), PXI-5661

Related Topics

System Reference Clock

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
pxiClk10Source	ViConstString	Specifies the signal to drive the 10 MHz Reference Clock on the PXI backplane. This option can only be configured when the PXI-5600 is in Slot 2 of the PXI chassis.

NIRFSA_VAL_NONE_STR ("None")	The device does not drive the PXI 10 MHz backplane Reference Clock.
NIRFSA_VAL_ONBOARD_CLOCK_STR ("OnboardClock")	The device drives the PXI 10 MHz backplane Reference Clock with the PXI-5600 onboard clock. You must connect the 10 MHz OUT connector to the PXI 10 MHz I/O connector on the PXI-5600 front panel to use this option.
NIRFSA_VAL_REF_IN_STR ("RefIn")	The device drives the PXI 10 MHz backplane Reference Clock with the reference source attached to the PXI-5600 REF IN connector. You must connect the 10 MHz OUT connector to the PXI 10 MHz I/O on the PXI-5600 front panel to use this option.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ExportSignal

ViStatus niRFSA_ExportSignal(ViSession vi, ViInt32 signal, ViConstString signalIdentifier, ViConstString outputTerminal);

Purpose

Routes signals (triggers, clocks, and events) to the specified output terminal.

If you export a signal with this function and [commit](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_Commit.html')) the session, the signal is routed to the output terminal you specify. If you then reconfigure the signal to have a different output terminal, the previous output terminal is tri-stated when the session is next committed. If you set the outputTerminal parameter to NIRFSA_VAL_DO_NOT_EXPORT and commit, the previous output terminal is tristated.

Any signals, except for those exported over PXI trigger lines, that are exported within a session persist after the session closes to prevent signal glitches between sessions. PXI trigger lines are always set to tristate when a session is closed. If you wish to have the output terminal tristated when the session closes, change the outputTerminal for the exported signal to NIRFSA_VAL_DO_NOT_EXPORT, and commit the session again before closing it.

You can also tristate all PFI lines by setting the resetDevice parameter in the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) function to VI_TRUE or by using the [niRFSA_reset](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_reset.html')) function.

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

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
signal	ViInt32	Specifies the type of signal to route.

NIRFSA_VAL_START_TRIGGER (1100)	NI-RFSA routes a Start Trigger.
NIRFSA_VAL_REF_TRIGGER (702)	NI-RFSA routes a Reference trigger.
NIRFSA_VAL_ADVANCE_TRIGGER (1102)	NI-RFSA routes an Advance Trigger.
NIRFSA_VAL_READY_FOR_START_EVENT (1200)	NI-RFSA routes a Ready for Start Event.
NIRFSA_VAL_READY_FOR_ADVANCE_EVENT (1202)	NI-RFSA routes a Ready for Advance Event.
NIRFSA_VAL_READY_FOR_REF_EVENT (1201)	NI-RFSA routes a Ready for Reference Event.
NIRFSA_VAL_END_OF_RECORD_EVENT (1203)	NI-RFSA routes an End of Record Event.
NIRFSA_VAL_DONE_EVENT (1204)	NI-RFSA routes a Done Event.
NIRFSA_VAL_REF_CLOCK (1205)	NI-RFSA routes a Reference Clock signal.
NIRFSA_VAL_USER (1206)	NI-RFSA routes a user-defined signal, specified using the signalIdentifier parameter.

NIRFSA_VAL_DO_NOT_EXPORT_STR	The signal is not exported.
NIRFSA_VAL_CLK_OUT_STR	The signal is exported to the CLK OUT connector on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.
NIRFSA_VAL_REF_OUT_STR	The signal is exported to the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5694, PXIe-5644/5645/5646, or PXIe-5820/5830/5831/5832/5840/5841.
NIRFSA_REF_OUT2_STR	The signal is exported to the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.
NIRFSA_VAL_PFI0_STR	The signal is exported to the PFI 0 connector.
NIRFSA_VAL_PFI1_STR	The signal is exported to the PFI 1 connector on the PXI-5142 and PXIe-5622.
NIRFSA_VAL_PXI_TRIG0_STR	The signal is exported to the PXI trigger line 0.
NIRFSA_VAL_PXI_TRIG1_STR	The signal is exported to the PXI trigger line 1.
NIRFSA_VAL_PXI_TRIG2_STR	The signal is exported to the PXI trigger line 2.
NIRFSA_VAL_PXI_TRIG3_STR	The signal is exported to the PXI trigger line 3.
NIRFSA_VAL_PXI_TRIG4_STR	The signal is exported to the PXI trigger line 4.
NIRFSA_VAL_PXI_TRIG5_STR	The signal is exported to the PXI trigger line 5.
NIRFSA_VAL_PXI_TRIG6_STR	The signal is exported to the PXI trigger line 6.
NIRFSA_VAL_PXI_TRIG7_STR	The signal is exported to the PXI trigger line 7.
NIRFSA_VAL_PXI_STAR_STR	The signal is exported to the PXI star trigger line.
NIRFSA_VAL_PXIE_DSTARC_STR	The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

De-embedding

niRFSA_CreateDeembeddingSparameterTableS2PFile

ViStatus niRFSA_CreateDeembeddingSparameterTableS2PFile (ViSession vi, ViConstString port, ViConstString tableName, ViConstString s2pFilePath, ViInt32 sparameterOrientation);

Purpose

Creates an S-parameter de-embedding table for the port based on the specified S2P file.

If you only create one table for a port, NI-RFSA automatically selects that table to de-embed the measurement.

Supported Devices: PXIe-5830/5831/5832/5840/5841

Related Topics

De-embedding Overview

S-parameters

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
port	ViConstString	Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).
tableName	ViConstString	Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.
s2pFilePath	ViConstString	Specifies the path to the S2P file that contains de-embedding information for the specified port.
sparameterOrientation	ViInt32	Specifies the orientation of the data in the S2P file relative to the port on the DUT port.

NIRFSA_VAL_PORT1_TOWARDS_DUT (3800)	Port 1 of the S2P is oriented towards the DUT port.
NIRFSA_VAL_PORT2_TOWARDS_DUT (3801)	Port 2 of the S2P is oriented towards the DUT port.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_CreateDeembeddingSparameterTableArray

ViStatus niRFSA_CreateDeembeddingSparameterTableArray (ViSession vi, ViConstString port, ViConstString tableName, const ViReal64 frequencies[], ViInt32 frequenciesSize, const NIComplexNumber sparameterTable[], ViInt32 sparameterTableSize, ViInt32 numberOfPorts, ViInt32 sparameterOrientation);

Purpose

Creates an s-parameter de-embedding table for the port from the input data.

If you only create one table for a port, NI-RFSA automatically selects that table to de-embed the measurement.

Supported Devices: PXIe-5830/5831/5832/5840/5841

Related Topics

De-embedding Overview

S-parameters

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
port	ViConstString	Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).
tableName	ViConstString	Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.
frequencies	const ViReal64[]	Specifies the frequencies for the sparameterTable rows. Frequencies must be unique and in ascending order.
frequenciesSize	ViInt32	Specifies the size of the frequency.
sparameterTable	const NIComplexNumber[]	Specifies the S-parameters for each frequency. S-parameters for each frequency are placed in the array in the following order: s11, s12, s21, s22.
sparameterTableSize	ViInt32	Specifies the size of the S-parameter table.
numberOfPorts	ViInt32	Specifies the number of DUT ports.
sparameterOrientation	ViInt32	Specifies the orientation of the data in the S2P file relative to the port on the DUT port.

NIRFSA_VAL_PORT1_TOWARDS_DUT (3800)	Port 1 of the S2P is oriented towards the DUT port.
NIRFSA_VAL_PORT2_TOWARDS_DUT (3801)	Port 2 of the S2P is oriented towards the DUT port.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_DeleteDeembeddingTable

ViStatus niRFSA_DeleteDeembeddingTable (ViSession vi, ViConstString port, ViInt32 numberOfListAttributes, ViConstString tableName);

Purpose

Deletes the selected de-embedding table for a given port.

Supported Devices: PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
port	ViConstString	Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).
tableName	ViConstString	Specifies the name of the table.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_DeleteAllDeembeddingTables

ViStatus niRFSA_DeleteAllDeembeddingTables (ViSession vi);

Purpose

Deletes all configured de-embedding tables for the session.

Supported Devices: PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigureDeembeddingTableInterpolationNearest

ViStatus niRFSA_ConfigureDeembeddingTableInterpolationNearest (ViSession vi, ViConstString port, ViConstString tableName);

Purpose

Selects the nearest interpolation method. NI-RFSA uses the parameters of the table nearest to the carrier frequency for de-embedding.

Supported Devices: PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
port	ViConstString	Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).
tableName	ViConstString	Specifies the name of the table.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigureDeembeddingTableInterpolationLinear

ViStatus niRFSA_ConfigureDeembeddingTableInterpolationLinear (ViSession vi, ViConstString port, ViConstString tableName, ViInt32 format);

Purpose

Selects the linear interpolation method. If the carrier frequency does not match a row in the de-embedding table, NI-RFSA performs a linear interpolation based on the entries in the de-embedding table to determine the parameters to use for de-embedding.

Supported Devices: PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
port	ViConstString	Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).
tableName	ViConstString	Specifies the name of the table.
format	ViInt32	Specifies the format of parameters to interpolate.

NIRFSA_VAL_LINEAR_INTERPOLATION_FORMAT_REAL_AND_IMAGINARY (4000)	Results in a linear interpolation of the real portion of the complex number and a separate linear interpolation of the complex portion.
NIRFSA_VAL_LINEAR_INTERPOLATION_FORMAT_MAGNITUDE_AND_PHASE (4001)	Results in a linear interpolation of the magnitude and a separate linear interpolation of the phase.
NIRFSA_VAL_LINEAR_INTERPOLATION_FORMAT_MAGNITUDE_DB_AND_PHASEE (4002)	Results in a linear interpolation of the magnitude, in decibels, and a separate linear interpolation of the phase.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ConfigureDeembeddingTableInterpolationSpline

ViStatus niRFSA_ConfigureDeembeddingTableInterpolationSpline (ViSession vi, ViConstString port, ViConstString tableName);

Purpose

Selects the spline interpolation method. If the carrier frequency does not match a row in the de-embedding table, NI-RFSA performs a spline interpolation based on the entries in the de-embedding table to determine the parameters to use for de-embedding.

Supported Devices: PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
port	ViConstString	Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).
tableName	ViConstString	Specifies the name of the table.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_GetDeembeddingSparameters

ViStatus niRFSA_GetDeembeddingSparameters (ViSession vi, NIComplexNumber *sparameters, ViInt32 sparametersArraySize, ViInt32 *numberOfSparametersReturned, ViInt32 *numberOfPorts);

Purpose

Returns the S-parameters used for de-embedding a measurement on the selected port. This includes interpolation of the parameters based on the configured carrier frequency. This function returns an empty array if no de-embedding is done.

If you want to call this function just to get the required buffer size, you can pass 0 for S-parameter Size and VI_NULL for the S-parameters buffer.

	Note The port orientation for the returned S-parameters is normalized to NIRFSA_VAL_PORT2_TOWARDS_DUT.
Supported Devices: PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
sparametersArraySize	ViInt32	Specifies the size of the array that is returned by the sparameters output.
Output
Name	Type	Description
sparameters	NIComplexNumber*	Returns an array of S-parameters. The S-parameters are returned in the following order: s11, s12, s21, s22.
numberOfSparametersReturned	ViInt32*	Returns the number of S-parameters.
numberOfPorts	ViInt32*	Returns the number of S-parameter ports. The sparameter array is always n x n, where span n is the number of ports.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

Set/get/reset Attribute

Set Attribute

niRFSA_SetAttributeViInt32

ViStatus niRFSA_SetAttributeViInt32(ViSession vi, ViConstString channelName, ViAttr attributeId, ViInt32 value);

Purpose

Sets the value of a ViInt32 attribute.

Use this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.

NI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel-based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
value	ViInt32	Pass the value to which you want to set the attribute.

	Note Some of the values might not be valid depending on the current state of the instrument session.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_SetAttributeViInt64

ViStatus niRFSA_SetAttributeViInt64(ViSession vi, ViConstString channelName, ViAttr attributeId, ViInt64 value);

Purpose

Sets the value of a ViInt64 attribute.

Use this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.

NI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
value	ViInt64	Pass the value to which you want to set the attribute.

	Note Some of the values might not be valid depending on the current state of the instrument session.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_SetAttributeViReal64

ViStatus niRFSA_SetAttributeViReal64(ViSession vi, ViConstString channelName, ViAttr attributeId, ViReal64 value);

Purpose

Sets the value of a ViReal64 attribute.

Use this low-level function to set the values of inherent IVI attributes, and instrument-specific attributes.

NI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread-locking for you.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
value	ViReal64	Pass the value to which you want to set the attribute.

	Note Some of the values might not be valid depending on the current state of the instrument session.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_SetAttributeViString

ViStatus niRFSA_SetAttributeViString(ViSession vi, ViConstString channelName, ViAttr attributeId, ViConstString value);

Purpose

Sets the value of a ViString attribute.

Use this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.

NI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
value	ViConstString	Pass the value to which you want to set the attribute.

	Note Some of the values might not be valid depending on the current state of the instrument session.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_SetAttributeViBoolean

ViStatus niRFSA_SetAttributeViBoolean(ViSession vi, ViConstString channelName, ViAttr attributeId, ViBoolean value);

Purpose

Sets the value of a ViBoolean attribute.

Use this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.

NI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
value	ViBoolean	Pass the value to which you want to set the attribute.

	Note Some of the values might not be valid depending on the current state of the instrument session.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_SetAttributeViSession

ViStatus niRFSA_SetAttributeViSession(ViSession vi, ViConstString channelName, ViAttr attributeId, ViSession value);

Purpose

Sets the value of a ViSession attribute.

Use this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.

NI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
value	ViSession	Pass the value to which you want to set the attribute.

	Note Some of the values might not be valid depending on the current state of the instrument session.

| :- | :- | :- |

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

Get Attribute

niRFSA_GetAttributeViInt32

ViStatus niRFSA_GetAttributeViInt32(ViSession vi, ViConstString channelName, ViAttr attributeId, ViInt32 *value);

Purpose

Queries the value of a ViInt32 attribute.

You can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
Output
Name	Type	Description
value	ViInt32*	Returns the current value of the attribute. Pass the address of a ViInt32 variable.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_GetAttributeViInt64

ViStatus niRFSA_GetAttributeViInt64(ViSession vi, ViConstString channelName, ViAttr attributeId, ViInt64 *value);

Purpose

Queries the value of a ViInt64 attribute.

You can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
Output
Name	Type	Description
value	ViInt64*	Returns the current value of the attribute. Pass the address of a ViInt64 variable.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_GetAttributeViReal64

ViStatus niRFSA_GetAttributeViReal64(ViSession vi, ViConstString channelName, ViAttr attributeId, ViReal64 *value);

Purpose

Queries the value of a ViReal64 attribute.

You can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
Output
Name	Type	Description
value	ViReal64*	Returns the current value of the attribute. Pass the address of a ViReal64 variable.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_GetAttributeViString

ViStatus niRFSA_GetAttributeViString(ViSession vi, ViConstString channelName, ViAttr attributeId, ViInt32 bufsize, ViChar value[]);

Purpose

Queries the value of a ViString attribute.

You can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.

You must provide a ViChar array to serve as a buffer for the value. You pass the number of bytes in the buffer as the bufSize parameter. If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the bufSize parameter, the function copies buffer size – 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is "123456" and the buffer size is 4, the function places "123" into the buffer and returns 7.

If you want to call this function just to get the required buffer size, you can pass 0 for bufSize and VI_NULL for the attributeValue buffer.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
bufSize	ViInt32	Pass the number of bytes in the ViChar buffer you specify for the attribute value parameter. If you pass 0, you can pass VI_NULL for the attribute value buffer parameter.
Output
Name	Type	Description
value	ViChar[]	The buffer in which the function returns the current value of the attribute. The buffer must be of type ViChar and have at least as many bytes as indicated in bufSize. If you specify 0 for the bufSize parameter, you can pass VI_NULL for this parameter.

Return Value

Name	Type	Description
statusOrRequiredSize	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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_error_message.html')) function. To obtain additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from the driver, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_GetAttributeViBoolean

ViStatus niRFSA_GetAttributeViBoolean(ViSession vi, ViConstString channelName, ViAttr attributeId, ViBoolean *value);

Purpose

Queries the value of a ViBoolean attribute.

You can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
Output
Name	Type	Description
value	ViBoolean*	Returns the current value of the attribute. Pass the address of a ViBoolean variable.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_GetAttributeViSession

ViStatus niRFSA_GetAttributeViSession(ViSession vi, ViConstString channelName, ViAttr attributeId, ViSession *value);

Purpose

Queries the value of a ViSession attribute.

You can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.
Output
Name	Type	Description
value	ViSession*	Returns the current value of the attribute. Pass the address of a ViSession variable.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

niRFSA_ResetAttribute

ViStatus niRFSA_ResetAttribute(ViSession vi, ViConstString channelName, ViAttr attributeId);

Purpose

Resets the attribute to its default value.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
channelName	ViConstString	Specifies the name of the channel on which to reset the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.
attributeId	ViAttr	Pass the ID of an attribute.

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](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

| :- | :- | :- |

NI-DAQmx

gRPC API Differences From C API

Task Configuration And Control

Channel Configuration And Creation

Timing

Triggering

Read Functions

Write Functions

Export Hardware Signals

Scale Configuration

Internal Buffer Configuration

Advanced Functions

System Configuration

Error Handling

Buffer Attributes

Calibration Info Attributes

Channel Attributes

Device Attributes

Export Signal Attributes

Persisted Channel Attributes

Persisted Scale Attributes

Persisted Task Attributes

Physical Channel Attributes

Read Attributes

Scale Attributes

System Attributes

Task Attributes

Timing Attributes

Trigger Attributes

Watchdog Attributes

Write Attributes

NI-DCPOWER

Setup Functions

Configure Functions

Measurement Functions

Control Functions

Trigger And Event
Attribute Functions

Query Functions

Calibration Functions

Utility Functions

Supported Device
Source Attributes

Transient Attributes

Voltage Attributes

Current Attributes

Pulse Voltage Attributes

Pulse Current Attributes

Cutoff Attributes

Measurement Attributes

Trigger Attributes Functions

Event Attributes

Advanced Attributes

Inherent Ivi Attributes

Supported Device Attributes

NI-DIGITAL PATTERN DRIVER

Init And Close Functions

Session Locking Functions

Utility Functions

Error Handling Functions

Calibration Functions

Attributes Functions

Pin Map Functions

Low Level Functions

Low Level Action Functions

Pin Control Functions

Static IO Functions

Clock Generator Functions

Levels And Timing Functions

TDR Functions

PPMU Configuration Functions

DC Voltage Functions

DC Current Functions

PPMU Action Functions

Pattern Configuration Functions

Pattern Action Functions

History Ram Functions

Source Memory Functions

Capture Memory Functions

Triggers And Events Functions

Conditional Jump Trigger Functions

Sequencer Flag Functions

Sequencer Register Functions

Match Fail Combination Functions

Pattern Results Functions

Sort Results Functions

Frequency Measurement Functions

IVI Inherent Attributes

Specific Driver Information Attributes, Read Only

Driver Setup Information Attributes

Device Attributes

Pin Control Attributes

Level Configuration Attributes

Trigger Configuration Attributes

PPMU Attributes

Patterns Attributes

Pattern Opcode Event Attributes

Timing Offset Attributes

Keep Alive Attributes

Frequency Measurement Attributes

Clock Generator Attributes

History RAM

Synchronization Attributes

TDR Endpoint Termination Attributes

NI-DMM

Setup Functions

Configuration Functions

Measurement Functions

Trigger Functions

Values And Attribute Functions

Acquisition Functions

Calibration Functions

Utility Functions

Configuration Attributes

Inherent IVI Attributes

Multi Point Acquisition Attributes

NI-FGEN

Setup Functions

Configuration Functions

Standard Output Functions

Arbitrary Waveform Output Functions

Arbitrary Sequence Output Functions

Incremental Waveform Write Functions

Configure Clock Functions

Trigger And Syncronizations Functions

5404 Routing Functions

Script Output Functions

Configure Onboard Signal Processing Functions

Configure Peer To Peer Functions

Attribute Functions

Waveform Control Functions

Error Functions

Output Attributes

Arbitrary Waveform Attributes

Data Transfer Attributes

Onboard Signal Processing Attributes

Peer To Peer Attributes

Standard Function Attributes

Clock Attributes

Event Attributes

Triggering Attributes

Instrument Specific Attributes

Inherent IVI Attributes

5401 5411 5431

NI-FPGA

gRPC API Differences From C API

NI FPGA C Functions

NI-RFmx Bluetooth

gRPC API Differences From C API

General Functions

Configuration Functions

Set And Get Attribute Functions

Fetch Results Functions

Utility Functions

Build String Functions

Advanced Functions

General Attributes

Trigger Attributes

Packet Attributes

Auto Detect Signal Attributes

Modacc Attributes

ACP Attributes

Twenty dB Attributes

Frequency Range Attributes

TXP Attributes

Advanced Attributes

NI-RFmx NR

gRPC API Differences From C API

General Functions

Configuration Functions

Set And Get Attributes Functions

Fetch Results Functions

Utility Functions

Build String Functions

Advanced Functions

General Attributes

Trigger Attributes

Signal Detection Attributes

Component Carrier Attributes

List Attributes

Modacc Attributes

ACP Attributes

CHP Attributes

OBW Attributes

SEM Attributes

TXP Attributes

Pvt Attributes

Advanced Attributes

NI-RFmx WCDMA

gRPC API Differences From C API

NI RFmx WCDMA C Functions

NI-RFmx GSM

gRPC API Differences From C API

NI RFmx GSM C Functions

NI-RFmx CDMA2k

gRPC API Differences From C API

NI RFmx CDMA2k C Functions

NI-RFmx Instr

General Functions

Configuration Functions

Set And Get Attributes Functions

Utility

Build String

Calibration

Attributes

Advanced Attributes

NI-RFmx LTE

gRPC API Differences From C API

General Functions

Configuration Functions

Ch Configuration Functions

NB IoT Configuration Functions

ModAcc Configuration Functions

ACP Configuration Functions

CHP Configuration Functions

OBW Configuration Functions

SEM Configuration Functions

PVT Configuration Functions

SlotPhase Configuration Functions

SlotPower Configuration Functions

Set And Get Attribute Functions

ModAcc Fetch Functions

ACP Fetch Functions

CHP Fetch Functions

OBW Fetch Functions

SEM Fetch Functions

PVT Fetch Functions

SlotPhase Fetch Functions

SlotPower Fetch Functions

Utility Functions

Build String Functions

Advanced Functions

General Attributes

Trigger Attributes

Component Carrier Attributes

ModAcc Attributes

ACP Attributes

CHP Attributes

OBW Attributes

SEM Attributes

PVT Attributes

SlotPhase Attributes

SlotPower Attributes

Advanced Attributes

NI-RFmx SpecAn

gRPC API Differences From C API

General Functions

Configuration Functions

Set And Get Attribute Functions

Read Functions

Fetch Functions

Utility Functions

Marker Functions

Build String Functions

Advanced Functions

General Attributes

Trigger Attributes

ACP Attributes

Cdf Attributes

CHP Attributes

Fcnt Attributes

Harm Attributes

OBW Attributes

SEM Attributes

Spectrum Attributes

Spur Attributes

TXP Attributes

AMPM Attributes

Dpd Attributes

IQ Attributes

IM Attributes

NF Attributes

Phasenoise Attributes

PAVT Attributes

Advanced Attributes

NI-RFmx TD-SCDMA

gRPC API Differences From C API

NI RFmx TD-SCDMA C Functions

NI-RFmx WLAN

gRPC API Differences From C API

General Functions

Configuration Functions

Set And Get Attribute Functions

Fetch DSSS ModAcc Functions

Fetch OFDM ModAcc Functions

Fetch SEM Functions

Fetch TXP Functions

Fetch PowerRamp Functions

Utility Functions

Build String Functions

Advanced Functions

General Attributes

Trigger Attributes

OFDM Attributes

Auto Detect Signal Attributes

DSSS ModAcc Attributes

OFDM ModAcc Attributes

SEM Attributes

TXP Attributes

PowerRamp Attributes

Advanced Attributes

NI-RFSA

General Functions

Configuration Functions

Acquisition Functions

Utility Functions

Calibration Functions

General Attributes

Vertical Attributes

Signal Path Attributes

Acquisition Attributes

Acquisition Attributes

Triggers Attributes

Events Attributes

Device Characteristics Attributes

Peer To Peer Streaming Attributes

Configuration List Attributes

Inherent IVI Properties Attributes

De-embedding Attributes

Self Calibration Attributes

Factory Calibration Attributes

External Alignment Attributes

Device Specific Attributes

NI-RFSG

General Functions

Generation Configuration

Utility Functions

Calibration Functions

Arb Attributes

Clock Attributes

Configuration List Attributes

De-embedding Attributes

Device Characteristics Attributes

Device Specific Attributes

Events Attributes

External Calibration Attributes

Inherent IVI Attributes Attributes

IQ Impairment Attributes

Load Configurations Attributes

Modulation Attributes

Obsolete Attributes

Peer To Peer Attributes

RF Attributes

Self Calibration Attributes

Triggers Attributes

NI-SCOPE

Setup Functions

Configure Functions

Attribute Functions

Acquisition Functions

Measurement Functions

Calibrate Functions

Utility Funcitons

Error Handling Functions

IVI Compliance Or Obsolete Functions

Vertical Attributes

Horizontal Attributes

Trigger Attributes

Clocking Attributes

Synchronization Attributes

Acquisition Attributes

Waveform Measurements Attributes

Onboard Signal Processing Attributes

Peer To Peer Streaming Attributes

Device Attributes

IVI Or Obsolete Attributes

Instrument Capabilities Attributes

If Digitizer Attributes

NI-SWITCH

Setup Functions

Attribute Functions

Route Functions

Scan Functions

Relay Functions

Utility Functions

Value Constants

Channel Configuration Attributes

IVI Attributes

Matrix Configuration Attributes

Module Characteristics Attributes

Scanning Configuration Attributes

NI-TCLK

High-level Functions

Advanced Functions

Attribute Functions

NI-XNET

gRPC API differences from C APIs

General Functions

Cluster Properties

Database Properties

Device Properties

ECU Properties

Frame Properties

Interface Properties

LIN Schedule Entry Properties

LIN Schedule Properties

PDU Properties

Session Ethernet Properties

Session Frame Properties

Session Interface Properties

Session Properties

Session SAE J1939 Properties

Signal Properties

Subframe Properties

System Properties

IP-Stack Functions

Socket Options

Socket Functions