#API #Results

Type: Alias
Description: Alias for INT values used to represent status codes.

• Result >= 1 - Ok
• Result = 0 - None
• Result <= -1 - Error

Type: GVL
Description:
Predefined Result error constants.

• Itf0
  Value: -2
  Null interface.
• Str0
  Value: -3
  Empty string.
• ItfEq
  Value: -4
  Interfaces are equal.
• NoMatch
  Value: -5
  No match found.
• Ptr0
  Value: -6
  Null pointer.
• InvRef
  Value: -7
  Invalid reference.
• Ovf
  Value: -8
  Overflow or out-of-bounds.
• Udf
  Value: -9
  Undefined.
• Idx
  Value: -10
  Index error.
• TcLib
  Value: -11
  Error from TwinCAT libraries.
• InfLoop
  Value: -12
  Potential infinite loop detected.
• IncArg
  Value: -13
  Incorrect input argument.
• Init
  Value: -14
  Initialization error.
• NotFound
  Value: -15
  Item not found.
• InvItf
  Value: -16
  Invalid interface.
• End
  Value: -17
  End.

Type: Function
Description:
Converts a Result value to its corresponding string description. Signature:

FUNCTION ResultToStr : Str
VAR_INPUT
    nResult : Result; // Result value to convert
END_VAR

Type: Function
Description:
Returns TRUE if Result < 0. Optionally copies value to output for reuse. Signature:

FUNCTION IsErr : BOOL
VAR_INPUT
    nIn : Result; // Input result
END_VAR
VAR_OUTPUT
    nOut : Result; // Output result
END_VAR

Type: Function
Description:
Returns TRUE if Result = Err.End. Optionally copies value to output for reuse. Signature:

FUNCTION IsEnd : BOOL
VAR_INPUT
    nIn : Result; // Input result
END_VAR
VAR_OUTPUT
    nOut : Result; // Output result
END_VAR

Type: Function
Description:
Returns TRUE if Result <= 0. Optionally copies value to output for reuse. Signature:

FUNCTION IsFail : BOOL
VAR_INPUT
    nIn : Result; // Input result
END_VAR
VAR_OUTPUT
    nOut : Result; // Output result
END_VAR

Type: Function
Description:
Returns TRUE if Result = 0. Optionally copies value to output for reuse. Signature:

FUNCTION IsNone : BOOL
VAR_INPUT
    nIn : Result; // Input result
END_VAR
VAR_OUTPUT
    nOut : Result; // Output result
END_VAR

Type: Function
Description:
Returns TRUE if Result > 0. Optionally copies value to output for reuse. Signature:

FUNCTION IsOk : BOOL
VAR_INPUT
    nIn : Result; // Input result
END_VAR
VAR_OUTPUT
    nOut : Result; // Output result
END_VAR

Type: Function
Description:
Returns TRUE if Result <> 0. Optionally copies value to output for reuse. Signature:

FUNCTION IsSome : BOOL
VAR_INPUT
    nIn : Result; // Input result
END_VAR
VAR_OUTPUT
    nOut : Result; // Output result
END_VAR