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

niWLANG_RFSGRetrieveIQRate

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_RFSGRetrieveIQRate (ViSession rfsgSession, 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.

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.
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 in the RFSG database.
Output
Name Type Description
IQRate float64* Returns the I/Q rate stored in the RFSG database for the waveform you specified in the waveformName parameter. 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