niRFSG_Commit
C Function Prototype
ViStatus niRFSG_Commit (ViSession vi);
Purpose
Asserts the configured hardware parameters. This function verifies attribute values, reserves the device, and commits the attribute values to the device. If the attributes values are all valid, the device configuration matches the session configuration. Calling this function moves the NI-RFSG device from the Configuration state to the Committed state. After calling this function, changing any attribute reverts the NI-RFSG device to the Configuration state.
Supported devices: NI 5610 (upconverter only mode), NI 5650/5651/5652/5670/5671/5672
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session. Default Value: None |
Return Value
| Name | Type | Description | ||||||||
| status | ViStatus | 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 instrument driver function to determine if an error occurred.
To obtain a text description of the status code, call the niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function. The general meaning of the status code is as follows:
|