RFmxPulse_Commit
- Updated2024-10-14
- 1 minute(s) read
RFmxPulse_Commit
int32 __stdcall RFmxPulse_Commit (niRFmxInstrHandle instrumentHandle, char selectorString[]);
Purpose
Commits settings to the hardware. Calling this function is optional. RFmxPulse commits settings to the hardware when you call the
RFmxPulse_Initiate function.
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. If you do not specify the signal name, the default signal instance is used. Example: "signal::sig1" 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:
|
||||||||