IviFgen_AbortGeneration
IviFgen Base Capability Group
C Function Prototype
ViStatus IviFgen_AbortGeneration (ViSession vi);
Purpose
This function aborts a previously initiated signal generation. If the function generator is in the Output Generation State, this function moves the function generator to the Configuration State. If the function generator is already in the Configuration State, the function does nothing and returns VI_SUCCESS.
You can configure the output of the function generator regardless of whether the function generator is in the Configuration State or the Output Generation State. This means that you are not required to call this function prior to configuring the output of the function generator.
You are not required to call this function or the IviFgen_InitiateGeneration 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.
 |
Note 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. |
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. |