niFgen_ConfigureFrequency

NI-FGEN C Function

niFgen_ConfigureFrequency

ViStatus niFgen_ConfigureFrequency (ViSession vi, ViConstString channelName, ViReal64 frequency);

Purpose

Configures the frequency of the standard waveform that you want the signal generator to produce.

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.
channelName ViConstString Specifies the channel name for which you want to configure a standard waveform.

Default Value: "0"

frequency ViReal64 Specifies the frequency of the standard waveform that you want the signal generator to produce. NI-FGEN sets the NIFGEN_ATTR_FUNC_FREQUENCY attribute to this value.

Notes  This parameter does not affect signal generator behavior when you set the waveform parameter of the niFgen_ConfigureStandardWaveform function to NIFGEN_VAL_WFM_DC.
Frequency ranges vary from device to device. For information about the frequencies supported on your device, refer to the Features supported topic for your device.

Units: hertz

Default Value: None

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