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

niWLANG_RFSGRetrieveRFBlankingMarkerPositions

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_RFSGRetrieveRFBlankingMarkerPositions (ViSession rfsgSession, char waveformName[], int32 rfBlankingMarkerPositionsArraySize, int32 rfBlankingMarkerPositions[], int32 *actualRFBlankingMarkerPositionsArraySize);

Purpose

Returns the RF blanking marker positions stored in the RFSG database. The function uses the waveform name as the key to retrieve the waveform properties.

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.
waveformName char[] Specifies the names of the waveforms to clear. If you set this parameter as empty, the function clears all the waveforms and their properties.
rfBlankingMarkerPositionsArraySize int32 Specifies the number of elements in the rfBlankingMarkerPositions array.
Output
Name Type Description
rfBlankingMarkerPositions int32[] Returns the RF blanking marker positions saved in the TDMS file. It is an array of sample positions, within waveform, of marker events that can be used to toggle the state of RF blanking.
actualRFBlankingMarkerPositionsArraySize int32* Specifies the actual number of elements populated in the rfBlankingMarkerPositions array.

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