View source for Error Cluster From Error Code function

{{TOCright}}
{{LabVIEW Palette Object Information|palette=Functions Palette/Programming/Dialog & User Interface{{!}}Dialog & User Interface palette|type=vi|icon=Dialog & User Interface Palette - Error Cluster From Error Code.png}}
[[File:Error Cluster From Error Code - Terminals.png|thumb|Error Cluster From Error Code function]]
The '''Error Cluster From Error Code''' function builds an [[Error Cluster data type|error cluster]] from an error code.

== Uses ==
Set the input terminal '''error code''' to zero in order to return the value of the '''error in''' input terminal (no error by default). This is useful in situations where zero indicates a passed state.

[[File:Error Cluster From Error Code - Error 0.png]]

Set the input terminal '''error code''' to a <u>non-zero</u> value to generate an error if the status of the '''error in''' input terminal is ''false''. 

[[File:Error Cluster From Error Code - Non-Zero Error.png]]

Use the '''error message''' input terminal to specify a custom error message (empty by default).

[[File:Error Cluster From Error Code - Error With Error Message.png]]

Set '''show call chain?''' to ''true'' to include all callers in the error message.

[[File:Error Cluster From Error Code - Show Call Chain.png]]

Set '''is warning?''' to ''true'' to return a warning instead of an error. If there is already a warning at the '''error in''' input terminal, the value is left unchanged.

[[File:Error Cluster From Error Code - Is Warning.png]]

== Best practice ==
* Specify custom error messages to improve readability and help others understand what the error means.
* Use [[Custom Error Code|custom error codes]] to avoid conflicts with [[Default Error Code|default error codes]].
* Use different error codes for different errors in the application.

== History ==
{| class="wikitable"
! Version
! Change(s)
|-
|[[File:LV8-2013.png|frameless|border|64x64px|LabVIEW 8.20|link=LabVIEW 8.20]]
|{{ambox|text=What changes have occurred over previous versions?}}
|}

== See also ==
*[[Default Error Code]]
*[[Custom Error Code]]
*[[Error Ring]]

== External links ==
*[https://zone.ni.com/reference/en-XX/help/371361R-01/glang/err_cluster_from_code/ Error Cluster From Error Code VI] (ni.com)

{{stub}}

[[Category:Error Handling]]
[[Category:Dialog & User Interface Palette]]