Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

Error Cluster From Error Code

LabVIEW 8.5 Help
August 2007

NI Part Number:
371361D-01

»View Product Info

Converts an error or warning code to an error cluster. This VI is useful when you receive a return value from a DLL call or when you return user-defined error codes.

If is warning? is TRUE, status returns FALSE to indicate that a warning occurred. The default is FALSE.
If show call chain? is TRUE, source includes the chain of callers from the VI that produced the error or warning to the top-level VI. The default is FALSE, which indicates to include only the calling VI. This VI uses the Call Chain function to obtain the chain of callers.
error code is the code you want to convert to an error cluster. The default is 0, which indicates that no error occurred.
error message is the error description to appear in the error out cluster. LabVIEW displays the description in error message when the General Error Handler VI receives this error out cluster. If error message is empty, LabVIEW uses error code to determine the error description from existing LabVIEW error codes.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
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 nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
error out contains error information corresponding to the error code. Right-click the error out indicator on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error or warning.
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 describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit