niFgen_ConfigureReferenceClock
ViStatus niFgen_ConfigureReferenceClock (ViSession vi, ViConstString referenceClockSource, ViReal64 referenceClockFrequency);
Purpose
Configures the signal generator reference clock source and frequency. The signal generator uses the reference clock to tune the sample clock timebase of the signal generator so that the frequency stability and accuracy of the sample clock timebase matches that of the reference clock.
Parameters
| Input | ||||||||||||||||
| Name | Type | Description | ||||||||||||||
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session. | ||||||||||||||
| referenceClockSource | ViConstString | Specifies the source for the Reference clock.
For example, when you set this parameter to "ClkIn," the signal generator uses the signal it receives at its Clk In front panel connector as the Reference clock. The Reference clock phase-locks with the signal generator Sample clock timebase to allow the frequency stability and accuracy of the sample clock timebase to match that of the Reference clock.
Defined Values
Default Value: "None" |
||||||||||||||
| referenceClockFrequency | ViReal64 | The reference clock frequency in hertz.
Default Value: 10000000 |
||||||||||||||
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 can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|