niRFSG_ConfigureRefClock
C Function Prototype
ViStatus niRFSG_ConfigureRefClock (ViSession vi, ViConstString clockSource, ViReal64 refClockRate);
Purpose
Configures the NI-RFSG device reference clock. The reference clock ensures that the NI-RFSG devices are operating from a common timebase. The NI-RFSG device must be in the Configuration state before calling this function.
Supported Devices: 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 |
||||||||
| clockSource | ViConstString | Specifies the source of reference clock signal.
Only certain combinations of the clockSource parameter and NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE are valid, as shown in the following table
NI-RFSG sets NIRFSG_ATTR_REF_CLOCK_SOURCE to this value. |
||||||||
| refClockRate | ViReal64 | Specifies the reference clock rate, expressed in Hz. NI-RFSG sets NIRFSG_ATTR_REF_CLOCK_RATE to this value. Default Value: 10E6 (10 MHz; this is the only supported value) |
||||||||
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:
|