Whitebeam Template Reference Documentation

Whitebeam Template Reference Documentation

Schedule Template

event.modify()

Modify an existing event record

See Also

rb.schedule.event.create, remove()

Syntax

number = rb.schedule.event.modify(data, activate)

Parameters

The 'event.modify' method takes 2 parameters:

Name	Type/Value	Range/Length	Description
data	struct event.eventDef	see definition	Required. Structure containing the value to be applied to the stored event record
activate	bool		Optional, default = 0 Set to true to attempt to activate the new event automatically

Results

The 'event.modify' method returns number:

Type/Value	Range/Length	Description
number		Unique ID of the changed record if the changes are successfully applied, or -1 if the update failed

Remarks

Change the fields in a specific record.

Whitebeam release 1.3.36

(loadtime : 92ms)