IviScope_IsInvalidWfmElement
IviScopeBase Capability Group
C Function Prototype
ViStatus IviScope_IsInvalidWfmElement (ViSession vi, ViReal64 elementValue, ViBoolean *isInvalid);
Purpose
This function determines whether a value you pass from the waveform array is invalid.
After the read and fetch waveform functions execute, each element in the waveform array contains either a voltage or a value indicating that the oscilloscope could not sample a voltage. The driver uses an IEEE-defined NaN (Not a Number) value to mark as invalid each element in the waveform array for which the oscilloscope could not sample a voltage. This function determines whether a value you pass from the waveform array is invalid.
Parameters
Inputs | Type | Description |
vi | ViSession | The instrument handle that you obtain from the IviScope_init or IviScope_InitWithOptions functions. The handle identifies a particular IVI session. |
elementValue | ViReal64 | Pass one of the values from the waveform array returned by the Read and Fetch Waveform functions. |
Outputs | Type | Description |
isInvalid | ViBoolean | Returns whether the elementValue is a valid voltage or a value indicating that the oscilloscope could not sample a voltage. Valid Return Values: VI_TRUE—The elementValue indicates that the oscilloscope could not sample the voltage. VI_FALSE—The elementValue is a valid voltage. |