RFmx CDMA2K CVI

RFmxCDMA2k_Commit

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

RFmxCDMA2k_Commit

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

Purpose

Commits settings to the hardware. Calling this function is optional. RFmxCDMA2k commits settings to the hardware when you call the RFmxCDMA2k_Initiate function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxCDMA2k_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxCDMA2k_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 RFmxCDMA2k_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors