RFmxNR_PvtCfgOffPowerExclusionPeriods
- Updated2025-04-08
- 1 minute(s) read
Configures the time excluded from the off region before and after the burst.
Syntax
int32 __stdcall RFmxNR_PvtCfgOffPowerExclusionPeriods(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offPowerExclusionBefore, float64 offPowerExclusionAfter)
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| instrumentHandle | [in] | niRFmxInstrHandle | This parameter specifies the RFmx session refnum. Instrument Handle In is obtained from the RFmxInstr_Initialize function. |
| selectorString | [in] | char | This parameter specifies a Selector String comprising of the signal name. If you do not specify the signal name, the default signal instance is used. The default is "" (empty string). |
| offPowerExclusionBefore | [in] | float64 | This parameter specifies the time excluded from the Off region before the burst. This value is expressed in seconds. The default value is 0. |
| offPowerExclusionAfter | [in] | float64 | This parameter specifies the time excluded from the Off region after the burst. This value is expressed in seconds. The default value is 0. |
Returns
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 RFmxNR_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |