NI-Sync LabVIEW API Reference

niSync Error Message (VI)

  • Updated2024-03-29
  • 3 minute(s) read

niSync Error Message (VI)

Installed With: NI-Sync

Converts an error or warning code returned by an NI-Sync VI into a readable string. You can then display the string in a dialog box or an indicator on the front panel.

niSync Error Message

cio.gif

instrument handle specifies the session handle that you obtain from the niSync Initialize VI. If you input VI_NULL as the instrument handle, the VI will also return VI_NULL for instrument handle out. This is useful when one of the initialize functions fail.

ci32.gif

error code specifies the error code that will be explained in a user-readable string. You can obtain an error code using the code parameter of an unbundled NI-Sync error cluster.

Note  If you do not wire this terminal, niSync Error Message will return "Operation completed successfully" even if there is an error in the program.
cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality. This node runs normally even if an error occurred before this node runs.

iio.gif

instrument handle out specifies the NI-Sync session handle that you obtain from the niSync Initialize VI. You can pass VI_NULL for this parameter. This is useful when one of the initialize functions fail.

istr.gif

error message returns a user-readable message string that explains the error code you specify in the error code terminal.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

Log in to get a better experience