niRFSA_ConfigureRefClock
ViStatus = niRFSA_ConfigureRefClock( ViSession vi, ViConstString clockSource, ViReal64 refClockRate);
Purpose
Configures the NI-RFSA device reference clock.
Parameters
Input | ||||||||
Name | Type | Description | ||||||
vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or the niRFSA_initWithOptions functions and identifies a particular instrument session. | ||||||
refClockSource | ViConstString | Specifies the reference clock source.
|
||||||
refClockRate | ViReal64 | Specifies the reference clock rate, expressed in Hertz. The default value is 10 MHz, which is the only currently 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. You 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 niRFSA_error_message function. To obtain additional information about the error condition, call the niRFSA_GetError function. To clear the error information from the driver, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
Meaning | |
---|---|---|---|---|
0 | Success | |||
Positive Values | Warnings | |||
Negative Values | Errors |