niFgen_ConfigureRefClockFrequency

NI-FGEN C Function

[OBSOLETE] niFgen_ConfigureRefClockFrequency

ViStatus niFgen_ConfigureRefClockFrequency (ViSession vi, ViReal64 referenceClockFrequency);

Purpose

Configures the signal generator reference clock frequency. The signal generator uses the reference clock to derive frequencies and sample rates when generating waveforms.

Note   The signal generator must not be in the Generating state when you call this function.

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.
referenceClockFrequency ViReal64 The reference clock frequency in Hz.

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:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors