Table Of Contents

Error Message (G Dataflow)

Last Modified: March 9, 2020

Converts an error or warning code returned by an NI-Sync function into a readable string.

You can display the error string in a dialog box or an indicator on the front panel.

connector_pane_image
datatype_icon

session in

The session handle that you obtain from Initialize or Initialize External Calibration.

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

This node runs normally even if an error occurred before this node runs.

Default: No error

datatype_icon

error code

The error code that is explained in a user-readable string. You can obtain an error code using code of an unbundled NI-Sync error cluster.

spd-note-note
Note

If you do not wire error code, Error Message will return "Operation completed successfully" even if there is an error in the program.

datatype_icon

session out

The session handle for the NI-Sync device. Pass this handle to other NI-Sync nodes to program the behavior of the device.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
datatype_icon

error message

A user-readable message string. This string explains the error code specified in error code.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics