niFgen_IsDone

NI-FGEN C Function

niFgen_IsDone

ViStatus niFgen_IsDone (ViSession vi, ViBoolean* done);

Purpose

Determines whether the current generation is complete. This function sets the done parameter to VI_TRUE if the session is in the Idle or Committed states.

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.
Output
Name Type Description
done ViBoolean* Returns information about the completion of waveform generation.

Defined Values

VI_TRUEGeneration is complete.
VI_FALSEGeneration is not complete.

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