MC_ErrorDescription
Function - Converts the PLCopen error IDs into message strings.
Inputs
Input |
Data Type |
Range |
Unit |
Default |
Description |
---|---|---|---|---|---|
En |
BOOL |
FALSE, TRUE |
N/A |
No default |
If TRUE, this function converts the ErrorID to a string message. |
ErrorID |
INT |
0, 69 |
N/A |
No default |
Error ID generated from a PLCopen function block. |
Outputs
Output |
Data Type |
Range |
Unit |
Description |
---|---|---|---|---|
OK |
BOOL |
FALSE, TRUE |
N/A |
If TRUE, the command completed successfully. |
Description |
STRING |
No range |
N/A |
String error description. |
Remarks
- See Function Blocks - General Rules about how inputs and outputs work.
- Return a text description corresponding to a motion control error ID code.
- The message strings can be used for display or logging.
Figure 1: MC_ErrorDescription
FBD Language Example
FFLD Language Example
IL Language Example
Not available.
ST Language Example
Description:= MC_ErrorDescription(ErrorID);