IviFgen_InitiateGeneration

IviFgen Base Capability Group

C Function Prototype

ViStatus IviFgen_InitiateGeneration (ViSession vi);

Purpose

This function initiates signal generation. If the function generator is in the Configuration State, this function moves the function generator to the Output GenerationState. If the function generator is already in the Output Generation State, this function does nothing and returns VI_SUCCESS.

The instrument is in the Generation State after you call the IviFgen_init, IviFgen_InitWithOptions, or IviFgen_reset functions. You can configure the output of the function generator regardless of whether the function generator is in the Configuration State or the Generation State. This means that you are required to call this function only if you abort signal generation by calling the IviFgen_AbortGeneration function.

Many function generators constantly generate an output signal and do not require you to initiate signal generation. If a function generator is always outputting the currently configured signal, this function does nothing.

You are not required to call this function or the IviFgen_AbortGeneration function. Whether you choose to call these functions in an application program has no impact on interchangeability. You can choose to use these functions if you want to optimize your application for instruments that exhibit increased performance when output configuration is performed while the instrument is not generating a signal.

This function disables unused extensions by applying default values to attributes in those extensions. For more information on default values, refer to default values.

Notes   This function does not normally check the instrument status. Typically, you call this function only in a sequence of calls to other low-level driver functions. The sequence performs one operation. You use the low-level functions to optimize one or more aspects of interaction with the instrument. If you want to check the instrument status, call the IviFgen_error_query function at the conclusion of the sequence. This function performs interchangeability checking when the IVIFGEN_ATTR_INTERCHANGE_CHECK attribute is set to VI_TRUE. Use NI Spy to view interchangeability warnings. Alternatively, you may use the IviFgen_GetNextInterchangeWarning function to retrieve interchangeability warnings. For information on interchangeability checking, consult the interchangeability section.

Parameter

Name	Type	Description
vi	ViSession	The instrument handle that you obtain from the IviFgen_init or IviFgen_InitWithOptions functions. The handle identifies a particular IVI session.

Return Values