« Back to Product

Documentation

IPS_SetEventTrigger

 bool IPS_SetEventTrigger (int $EventID, int $TriggerType, int $TriggerVariableID) 

Parameters

EventID

ID of the event to be changed

TriggerType
Value Constant Description
0 EVENTTRIGGERTYPE_ONUPDATE On Variable Update
1 EVENTTRIGGERTYPE_ONCHANGE On Variable Change
2 EVENTTRIGGERTYPE_ONLIMITEXCEED On Limit Exceed - Value is determined by IPS_SetEventTriggerValue
3 EVENTTRIGGERTYPE_ONLIMITDROP On Limit Drop - Value is determined by IPS_SetEventTriggerValue
4 EVENTTRIGGERTYPE_ONVALUE On specific Value - Value is determined by IPS_SetEventTriggerValue
TriggerVariableID

VariableID whose change or update should be responded to

Returns

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

Description

This function configures a triggering event. It defines the observed variable TriggerVariableID and which TriggerType the event should react to.

Example

IPS_SetEventTrigger($EventID, EVENTTRIGGERTYPE_ONUPDATE, 12345); // On update of variable 12345
Any questions?