SUCCEEDED
Error codes or status codes of the type HRESULT are checked with this function for validity.
Return value
SUCCEEDED : BOOL;
Name | Type | Description |
|---|---|---|
SUCCEEDED | BOOL | Returns TRUE if no error. |
Inputs
VAR_INPUT
hr : DINT;
END_VAR
Name | Type | Description |
|---|---|---|
hr | DINT | Specification of the error code or status code of type HRESULT to be checked. |
HRESULT
The type HRESULT has the special feature that errors are represented by negative values. Warnings or information can optionally be output by means of positive values.
Declaration | Error range | No error | Message/info | Check functions |
|---|---|---|---|---|
hrErrorCode : HRESULT; | <0 | >=0 | >0 | IF SUCCEEDED(hrErrorCode) THEN IF FAILED(hrErrorCode) THEN |
Requirements
TwinCAT Version | Hardware | Libraries to be integrated |
|---|---|---|
TwinCAT 3.1, Build 4020 | x86, x64, ARM | Tc3_Module |