Decrement
Version 1.8
function Decrement(symbol: Symbol, minValue?: number): void
Version 1.10
function Decrement(ctx: Required<TcHmi.Context>, symbol: TcHmi.Symbol | null, minValue?: number | null, stepWidth?: number | null): void
The Decrement function counts a numerical value in a binding downward in steps of a specified step size.
Parameter
Name | Type | Description |
---|---|---|
ctx Available from version 1.10 | Context object Does not need to be specified by the user when used in a trigger or function expression. In this case the transfer and the evaluation is done by the corresponding parser. Is used by the caller to indicate success or failure to the framework during execution. If the function is used directly in JavaScript/TypeScript, the context object must be passed in the call and evaluated if necessary. | |
value | The value to be decremented. The value must be specified as a binding to a symbol. | |
minValue | A minimum value that may not be undershot. | |
stepWidth | The step size with which the value is to be decremented. |
Return value
Type | Description |
---|---|
void | No return value. |
NuGet package: Beckhoff.TwinCAT.HMI.Functions
![]() | NuGet packages are available from version 1.12. |
![]() | Available from 1.8 |