NI-VNA

niVNA_FetchSweepMeasurementIntoFile

  • Updated2023-02-21
  • 1 minute(s) read

niVNA_FetchSweepMeasurementIntoFile(ViSession instrumentHandle, ViConstString channel, ViConstString filePath, ViInt32 fileType, ViBoolean overwrite, ViReal64 timeout);

Purpose

Fetches the data from the device directly into a one- or two-port S-parameter file from the latest measurement.

Supported Devices: NI 5630/5632

Parameters

Input
Name Type Description
instrumentHandle ViSession Identifies your instrument handle.
channel ViConstString Specifies the channel for which this operation is targeted.
filePath ViConstString Specifies the absolute file path into which to save the data.
fileType ViInt32 specifies the type of file into which to save the data.

NIVNA_VAL_DATA_FILE_TYPE_S1P The data is saved in a one-port S-parameter file.
NIVNA_VAL_DATA_FILE_TYPE_S2P The data is saved in a two-port S-parameter file.
overwrite ViBoolean Specifies whether to overwrite the existing file, if one exists.
timeout ViReal64 Specifies the time to wait for the function to complete operation before returning an error. A negative value specifies that NI-VNA waits indefinitely. This value is expressed in seconds (s).

Return Value

Name Type Description
returnValue ViStatus 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 an NI-VNA 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 niVNA_GetError function. To clear the error information from NI-VNA, call the niVNA_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience