niFgen_ConfigureSampleClockSource

NI-FGEN C Function

niFgen_ConfigureSampleClockSource

ViStatus niFgen_ConfigureSampleClockSource (ViSession vi, ViConstString sampleClockSource);

Purpose

Sets the source of the Sample clock of the signal generator. Samples are generated based on the the Sample clock cycles. The Sample clock source can be internal or external.

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.
sampleClockSource ViConstString Specifies the sample clock source that you want the signal generator to use.

Note Note   The following Defined Values are examples of possible sample clock sources. For a complete list of the sample clock sources available on your device, refer to the Device Routes tab in MAX.

Defined Values
"OnboardClock"Onboard clock
"ClkIn"Clk In front panel connector
"PXI_Star"PXI star trigger line
"PXI_Trig0" PXI trigger line 0 or RTSI line 0
"PXI_Trig1" PXI trigger line 1 or RTSI line 1
"PXI_Trig2" PXI trigger line 2 or RTSI line 2
"PXI_Trig3" PXI trigger line 3 or RTSI line 3
"PXI_Trig4" PXI trigger line 4 or RTSI line 4
"PXI_Trig5" PXI trigger line 5 or RTSI line 5
"PXI_Trig6" PXI trigger line 6 or RTSI line 6
"PXI_Trig7" PXI trigger line 7 or RTSI line 7
"DDC_ClkIn" Sample clock from DDC connector

Default Value: "OnboardClock"

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