niFgen_ConfigureRefClockSource

NI-FGEN C Function

[OBSOLETE] niFgen_ConfigureRefClockSource

ViStatus niFgen_ConfigureRefClockSource (ViSession vi, ViInt32 referenceClockSource);

Purpose

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

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 ViInt32 Specifies the reference clock source that you want the signal generator to use. NI-FGEN sets the NIFGEN_ATTR_REF_CLOCK_SOURCE attribute to this value.

The signal generator derives the frequencies and sample rates that it uses to generate waveforms from the source you specify.

For example, when you set this parameter to NIFGEN_VAL_REF_CLOCK_EXTERNAL, the signal generator uses the signal it receives at its external clock terminal as the reference clock.

Defined Values

NIFGEN_VAL_REF_CLOCK_INTERNAL Internal clock source
NIFGEN_VAL_REF_CLOCK_EXTERNAL External clock source
NIFGEN_VAL_REF_CLOCK_RTSI_CLOCK RTSI clock
NIFGEN_VAL_REF_CLOCK_TTL7 TTL 7
NIFGEN_VAL_PXI_CLK10 PXI 10 MHz clock
NIFGEN_VAL_REF_IN External clock source
NIFGEN_VAL_RTSI_0 RTSI 0
NIFGEN_VAL_RTSI_1 RTSI 1
NIFGEN_VAL_RTSI_2 RTSI 2
NIFGEN_VAL_RTSI_3 RTSI 3
NIFGEN_VAL_RTSI_4 RTSI 4
NIFGEN_VAL_RTSI_5 RTSI 5
NIFGEN_VAL_RTSI_6 RTSI 6
NIFGEN_VAL_RTSI_7 RTSI 7
NIFGEN_VAL_CLK_IN CLK IN front panel connector

Default Value: NIFGEN_VAL_REF_CLOCK_INTERNAL

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