« Back to Product

Documentation

LCN_LimitOutput

 boolean LCN_LimitOutput (int $InstanceID, int $Value, int $Time, string $TimeType) 

Parameters

InstanceID

ID of the output to be switched

Value

Percentage value to be limited to (0..100)

Time

Period for which the output should be limited

TimeType

Indicates whether the limit should apply to seconds, minutes, hours or days

Returns

If the command succeeds, it returns TRUE, otherwise FALSE.

Description

Limits the output with the ID InstanceID for the period Time and time type TimeType to the value Value.

Time type Possible period
'S' (seconds) 1..60
'M' (minutes) 1..90
'H' (hours) 1..50
'D' (days) 1..45

Example

//Limits the output with ID 12345 to 36% for 8 hours
LCN_LimitOutput(12345, 36, 8, 'H');
Any questions?