Xantech CRM-WIC, Reference Manual

Page: 66 / 99

66
SetEventById ( EventId, Name, Type, Concurrent, Source, Match )
Sets the basic information about an existing Event.
Syntax
HRESULT SetEventById(
[in] long EventId,
[in] BSTR Name,
[in] long Type,
[in] long Concurrent,
[in] BSTR Source,
[in] BSTR Match,
[out, retval] VARIANT_BOOL* Success
);
Parameters
EventId [in] ID for the specified event.
Name [in] Name of the specified event.
Type [in] Type of the Event, e.g. Serial.
Set
Type
to one of the following values:
Value Type
1 Scheduled
2 Timer
3 Variable
4 Serial
Input
Concurrent [in] Set to 1 to execute Actions concurrently, and 0 otherwise.
Source [in] Port, variable, etc. to be used for the source of the Event’s trigger.
The value of
Source
depends on the type of Event.
Event Type Format String
Clock and Timer “RTC”
Variable Name of the Variable
Serial “Port%d”, where %d
represents a number
Match [in] Value to match to trigger the Event. If the Match value is an expression, then the expression will need to evaluate
to 1 to cause the Event to trigger.
Success [out, retval] TRUE if specified event was successfully set, FALSE if setting the event failed.
Remarks
Call this function to set up an Event. After making this call, a call to SetEventSchedule is required for all events of type
Clock or Timer.
A call to SetEventOption should also to be made to set or clear the expression flag for the Event’s match value.
SetEventByName ( Name, Type, Concurrent, Source, Match )
Using the name of an existing Event, this function sets the basic information about it.