RFmx Pulse CVI

Table of Contents

RFmxPulse_ClearNamedResult

  • Updated2024-10-14
  • 1 minute(s) read

RFmxPulse_ClearNamedResult

int32 __stdcall RFmxPulse_ClearNamedResult (niRFmxInstrHandle instrumentHandle, char selectorString[]);

Purpose

Clears a result instance specified by the result name in the selectorString parameter.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxPulse_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxPulse_BuildSignalString function to build the selector string.

Return Value

Name Type Description
status int32 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 RFmxPulse_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience