niFgen_ConfigureClockMode

NI-FGEN C Function

niFgen_ConfigureClockMode

ViStatus niFgen_ConfigureClockMode (ViSession vi, ViInt32 clockMode);

Purpose

Selects the clock mode for the signal generator.

For signal generators that support it, this function allows you to switch the sample clock to High-Resolution Sampling mode.

When in Divide-Down Sampling mode, you can only set the sample rate to certain frequencies, based on dividing down the update clock. However, in High-Resolution Sampling mode, you can set the sample rate to any value.

Note  The signal generator must not be in the Generating state when you call this function.
Note  You must call the niFgen_ConfigureOutputMode function to set the output mode to NIFGEN_VAL_OUTPUT_SEQ, NIFGEN_VAL_OUTPUT_ARB, or NIFGEN_VAL_OUTPUT_SCRIPT before calling 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.
clockMode ViInt32 Sets the clock mode of the signal generator.

Defined Values

NIFGEN_VAL_DIVIDE_DOWNDivide down sampling—Sample rates are generated by dividing the source frequency.
NIFGEN_VAL_HIGH_RESOLUTIONHigh resolution sampling—Sample rate is generated by a high resolution clock source.
NIFGEN_VAL_AUTOMATICAutomatic Selection—NI-FGEN selects between the divide-down and high-resolution clocking modes.

Default Value: Depends on the device

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