niRFSGPlayback_ReadPAPRFromFile
- Updated2023-02-21
- 1 minute(s) read
ViStatus __stdcall niRFSGPlayback_ReadPAPRFromFile(ViConstString filePath, ViInt32 waveformIndex, ViReal64 *PAPR);
Purpose
Returns the peak to average power ratio (PAPR) stored in the file. This function uses the waveformIndex parameter as the key to retrieve the waveform property.
Parameters
| Input | ||
| Name | Type | Description |
| filePath | ViConstString | Specifies the absolute path to the TDMS file from which the playback library reads the waveforms. |
| waveformIndex | ViInt32 | Specifies the waveform number in the file for which you want to read the PAPR. |
| Output | ||
| Name | Type | Description |
| PAPR | ViReal64* | Returns the PAPR stored in the file for the waveform number that you specified in the waveformIndex parameter. This value is expressed in dB. |
Return Value
| Name | Type | Description | ||||||||
| status | 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 RFmx 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 niRFSGPlayback_GetError function. The general meaning of the status code is as follows:
|
||||||||