GetEvent

This procedure was deprecated in HomeSeer 2.0.0.0 - please use GetEventByRef instead.

Purpose

This function returns an event.  The event is of type EventClass and can be used to retrieve and set properties of an event.  

An EventClass has a number of properties that holds information about an event.  You can access these properties to get and set this information.  The function NewEvent can be used to create a new empty event.  The properties of the event are listed below.

Parameters

Parameter: index
Type: integer
Description: This is the index of the desired event.

Returns

Return value: EventClass
Type: object

EventClass Object

See EventClass

Example

The following script shows how to reiterate though all events, get the event name, and reiterate though all the devices the event controls.

 

GetEvent Script Example 2, Part 1

 

 

GetEvent Script Example 2, Part 1