RFmxSpecAn_AMPMCfgReferenceWaveform
- Updated2025-10-13
- 2 minute(s) read
Configures the reference waveform and its attributes for the AMPM measurement.
Syntax
int32 __stdcall RFmxSpecAn_AMPMCfgReferenceWaveform(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 x0, float64 dx, NIComplexSingle referenceWaveform[], int32 arraySize, int32 idleDurationPresent, int32 signalType)
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 value is "" (empty string). Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString function to build the selector string. | |||||||||
| x0 | [in] | float64 | This parameter specifies the start time, in seconds. | |||||||||
| dx | [in] | float64 | This parameter specifies the sample duration, in seconds. | |||||||||
| referenceWaveform | [in] | NIComplexSingle[] | This parameter specifies the complex baseband samples, in volts. | |||||||||
| arraySize | [in] | int32 | Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter. | |||||||||
| idleDurationPresent | [in] | int32 | This parameter specifies whether the reference waveform contains an idle duration. The default value is False.
| |||||||||
| signalType | [in] | int32 | This parameter specifies whether the reference waveform is a modulated signal or tones. The default value is Modulated.
|
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 RFmxSpecAn_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |