RFmxSpecAnMX.Initiate Method
- Updated2024-07-17
- 1 minute(s) read
RFmx
Initiates all enabled measurements. Call this method after configuring the signal and measurement. This method asynchronously launches measurements in the background and immediately returns to the caller program. To get the status of measurements, you can use the CheckMeasurementStatus(String, Boolean) method.
Namespace: NationalInstruments.RFmx.SpecAnMX
Assembly: NationalInstruments.RFmx.SpecAnMX.Fx40 (in NationalInstruments.RFmx.SpecAnMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)
Syntax
public int Initiate( string selectorString, string resultName )
Public Function Initiate ( selectorString As String, resultName As String ) As Integer
Parameters
- selectorString String
- Specifies a selector string comprising the result name. The result name can either be specified through this input or the resultName parameter.If you do not specify the result name in this input, either the result name specified by resultName parameter or the default result instance is used. Example: "", "result::r1". You can use the BuildResultString(String) method to build the selector string.
- resultName String
-
Specifies the name to be associated with measurement results. Provide a unique name, such as "r1", to enable fetching multiple measurement results and traces. This input accepts the result name with or without the "result::" prefix.
Example:
"result::r1"
"r1"
Return Value
Int32Returns the status code of this method. The status code either indicates success or describes an error or warning condition.
Remarks
This method maps to the RFmxSpecAn_Initiate() function in C.