GetHeadroomMode(string, out RFmxSpecAnMXDpdApplyDpdHeadroomMode)
- Updated2025-10-13
- 1 minute(s) read
Gets whether to compute and apply the headroom of the predistorted waveform or to apply the value that you specify using the SetHeadroom(string, double) method on the predistorted waveform.
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public int GetHeadroomMode(string selectorString, out RFmxSpecAnMXDpdApplyDpdHeadroomMode value)
Remarks
This method maps to the RFmxSpecAn_DPDGetApplyDPDHeadroomMode() function in C.
Parameters
| Name | Type | Description |
|---|---|---|
| selectorString | string | Pass an empty string. The signal name that is passed when creating the signal configuration is used. |
| value | out RFmxSpecAnMXDpdApplyDpdHeadroomMode | Upon return, contains a value that indicates whether to compute and apply the headroom of the predistorted waveform or to apply the value that you specify using SetHeadroom(string, double) on the predistorted waveform. |
Returns
Returns the status code of this method. The status code either indicates success or describes an error or warning condition.