niFgen_ConfigureOutputMode

NI Signal Generators Help (NI-FGEN 18.1)

Edition Date: April 2018

Part Number: 370524V-01

»View Product Info
Download Help (Windows Only)

ViStatus niFgen_ConfigureOutputMode (ViSession vi, ViInt32 outputMode);

Purpose

Configures the output mode of the signal generator. The output mode determines how the signal generator produces waveforms. For example, you can select to generate a standard waveform, an arbitrary waveform, or a sequence of arbitrary 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, niFgen_InitWithOptions, or niFgen_InitializeWithChannels functions and identifies a particular instrument session.
outputMode ViInt32 Specifies the output mode that you want the signal generator to use. The value you specify determines which functions and attributes you can use to configure the waveform the signal generator produces.

Refer to the NIFGEN_ATTR_OUTPUT_MODE attribute for more information about setting this parameter.

Defined Values

NIFGEN_VAL_OUTPUT_FUNC Standard Function mode—Generates standard function waveforms such as sine, square, triangle, and so on.
NIFGEN_VAL_OUTPUT_FREQ_LIST Frequency List mode—Generates a standard function using a list of frequencies you define.
NIFGEN_VAL_OUTPUT_ARB Arbitrary waveform mode—Generates waveforms from user-created/provided waveform arrays of numeric data.
NIFGEN_VAL_OUTPUT_SEQ Arbitrary sequence mode—Generates downloaded waveforms in an order your specify.
NIFGEN_VAL_OUTPUT_SCRIPT Script mode—Allows you to use scripting to link and loop multiple waveforms in complex combinations.


Default Value: NIFGEN_VAL_OUTPUT_FUNC

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

WAS THIS ARTICLE HELPFUL?

Not Helpful