57
Event Methods
Most of the Event methods use the Event’s ID to retrieve information about an Event. The Event’s ID is
set when an Event is created, and is unique to the Event. The ID is re-issued when the system is powered
up or the reset button is pressed.
The index number of the Event within the event list could change, depending on whether new Events are
added or existing Events are deleted.
GetEventByIdx ( Idx )
Returns the Event ID for a specified index number.
Syntax
HRESULT GetEventByIdx(
[in] long Idx,
[out, retval] long* EventId
);
Parameters
Idx
[in] The index of the Event in the Event list
EventId
[out, retval] Event ID of the specified event.
Remarks
GetEventByIdx
is normally used as part of a loop for getting the list of created events. Use
GetEventCount
to get the
number of Events. Use
GetEventByIdx
to get the ID of the next Event in the list. Then use the ID and the remaining
Event functions to retrieve the information you are interested in, e.g. Name, Type, Actions, etc.
The index numbers start at 0 and stop at
Count-1
, where
Count
is gotten with
GetEventCount
.
If
-1
is returned, then index is out of range. If
-2
is returned, then the Event represented by
Idx
is in the process of being
deleted.
GetEventByName ( Name )
Returns an Event ID for an event with a specified name.
Syntax
HRESULT GetEventByName(
[in] BSTR Name,
[out, retval] long* EventId
);
Parameters
Name
[in] Name of the event to identify.
EventId
[out, retval] Event ID of the specified event.
Remarks
The ID returned by
GetEventByName
is used by the Event functions to retrieve information about the named Event, e.g.
Name, Type, Actions, etc.
If
-1
is returned, then the Event specified by
Name
doesn’t exist. If
-2
is returned, then the Event represented by
Name
is
in the process of being deleted.
Содержание CRM-WIC
Страница 1: ...Reference Manual Programming Guide Room Monitor Web Intelligent Controller Model CRM WIC...
Страница 7: ...7 Box Contents Box Contents for the CRM WIC Web Intelligent Controller Model CRMWIC Power Adapter...
Страница 8: ...8 Hardware User Interface Hardware User Interface for the CRM WIC...
Страница 16: ...16 For full details see the RPC section at the end of this manual...
Страница 43: ...43 This expression resolves to this value 0 1 4 3 1 Hello Hello 0...
Страница 98: ...98 Index...