niBTSG_RFSGRetrieveIQRate

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_RFSGRetrieveIQRate (ViSession RFSGHandle, char channelString[], char waveformName[], float64 *IQRate);

Purpose

Returns the I/Q rate stored in the RFSG database. The function uses the waveform name as the key to retrieve the waveform attributes.

Note Use the niBTSG_RFSGStoreIQRate function to store the I/Q rate in the RFSG database.

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.
waveformName char[] Specifies the name of the waveform for which you want to retrieve the I/Q rate. The toolkit uses the waveformName parameter as the key to retrieve the waveform attributes from the RFSG database.
Output
Name Type Description
IQRate float64* Returns the I/Q rate stored in the RFSG database for the waveform that you specify in the waveformName parameter.

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