Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

niWLANG_RFSGRetrieveIQRateAllWaveforms

NI WLAN Generation Toolkit 17.0 Help

Edition Date: May 2017

Part Number: 373725G-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall niWLANG_RFSGRetrieveIQRateAllWaveforms (ViSession rfsgSession, 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
rfsgSessions ViSession[] Specifies a reference to an NI-RFSG instrument session. This parameter is obtained from the niRFSG_init or niRFSG_InitWithOptions functions and identifies a particular instrument session.
channelString char[] Set this parameter to "" (empty string) or NULL.
script char[] Specifies the script that controls waveform generation. NI-RFSG supports multiple scripts that may be selected by name with the NIRFSG_ATTR_SELECTED_SCRIPT attribute.
Output
Name Type Description
IQRate float64* Returns the I/Q rate, if the I/Q rates are the same for all waveforms specified in the script parameter. If the I/Q rates are different, the function returns an error. This value is expressed in samples per second (S/s).

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 condition. Examine the status code from each call to the function to determine if an error occurred.

To obtain a text description of the status code, call the niWLANG_GetErrorString function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit