niFgen Commit

LabView FGEN

niFgen Commit

Causes a transition to the Committed state. This VI verifies property values, reserves the device, and commits the property values to the device. If the property values are all valid, NI-FGEN sets the device hardware configuration to match the session configuration. This VI does not support the NI 5401/5404/5411/5431 signal generators.

In the Committed state, waveforms, scripts, and sequences can be loaded into memory. If any properties are changed, NI-FGEN implicitly transitions back to the Idle state. This VI has no effect if the device is already in the Committed or Generating states, and returns a successful status value.

Calling this VI before niFgen Initiate Generation VI is optional but has several benefits:

  • Routes are committed, so signals are exported or imported.
  • Any reference clock and external clock circuits are phase-locked.
  • A subsequent niFgen Initiate Generation VI can run faster because the device is already configured.

Instrument Handle identifies your instrument session. Instrument Handle was obtained from the niFgen Initialize VI or niFgen Initialize With Options VI.
error in describes error conditions that occur before this VI or function runs.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.
source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.
Instrument Handle Out passes a reference to your instrument session to the next VI.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.