niBTSG_RFSGRetrieveIQRateAllWaveforms

NI Bluetooth Generation Toolkit 19.1 Help

Edition Date: October 2019

Part Number: 373432K-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall niBTSG_RFSGRetrieveIQRateAllWaveforms (ViSession RFSGHandle, char channelString[], char script[], float64 *IQRate);

Purpose

Checks the I/Q rate of all the waveforms in the script that you specify in the script parameter. This function returns the I/Q rate if the I/Q rates are the same for all the waveforms. If the I/Q rates are different, the function returns an error.

Parameters

Input
Name Type Description
RFSGHandle ViSession Identifies the instrument session. You can obtain this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function.
channelString char[] Set this parameter to "" (empty string) or NULL.
script char[] Specifies the RFSG script used to generate the signal. The function looks up the I/Q rate of all the waveforms contained in the script.
Output
Name Type Description
IQRate float64* Returns the I/Q rate if the I/Q rates are the same for all the waveforms that you specify in the script parameter. If the I/Q rates are different, the function returns an error.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning. Examine the status code from each call to an niBT SG 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 niBTSG_GetErrorString function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful