NI-HSDIO LabVIEW VIs

niHSDIO Commit VI

  • Updated2023-02-21
  • 5 minute(s) read
Installed With: NI-HSDIO

Programs the hardware for the data operation using the properties you select. Before entering the committed state, most property values are stored in software only; these values have not yet been programmed to the hardware. After the session is committed, the hardware is configured.

Related Topics

Details

Dynamic

This instance of niHSDIO Commit configures the hardware for a dynamic operation. Start the operation with the niHSDIO Initiate VI. If you commit while the dynamic operation is in progress, you receive an error.

For many operations it is not necessary to explicitly use the Dynamic instance of the niHSDIO Commit VI because the following VIs implicitly commit: niHSDIO Initiate, niHSDIO Read Waveform, niHSDIO Write Named Waveform, and niHSDIO Write Script.

niHSDIO Commit Dynamic

civrn.gif

instrument handle identifies your instrument session. instrument handle is obtained from the niHSDIO Init Acquisition Session VI, the niHSDIO Init Generation Session VI, or the niHSDIO Init Ext Cal VI.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

cbool.gif

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.

ci32.gif

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.

cstr.gif

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.

iivrn.gif

instrument handle out passes a reference to your instrument session to the next VI. instrument handle is obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI.

ierrcodeclst.gif

error out contains error information. This output provides standard error out functionality.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

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.

istr.gif

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.

Static

This instance of niHSDIO Commit configures the hardware for a static operation. For most static operations, it is not necessary to explicitly use the Static instance of the niHSDIO Commit VI because the following VIs implicitly commit: niHSDIO Read Static (U32) and niHSDIO Write Static (U32).

niHSDIO Commit Static

civrn.gif

instrument handle identifies your instrument session. instrument handle is obtained from the niHSDIO Init Acquisition Session VI, the niHSDIO Init Generation Session VI, or the niHSDIO Init Ext Cal VI.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

cbool.gif

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.

ci32.gif

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.

cstr.gif

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.

iivrn.gif

instrument handle out passes a reference to your instrument session to the next VI. instrument handle is obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI.

ierrcodeclst.gif

error out contains error information. This output provides standard error out functionality.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

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.

istr.gif

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.

Details

Committing programs only the hardware properties that have changed since previous commits.

Note  Committing some properties (for example, voltage levels), may have immediate effects on the signals at the device connectors.
Note  Before committing a session that requires an external clock, ensure the external clock is available. Otherwise, NI-HSDIO returns an error that the device cannot find or lock to the external clock.