Events actionFromXMLStart
From TrillWiki
The events_actionFromXMLStart notification is sent when the events engine reads the data associated with an event from xml. This notification will be triggered so that the plugin can initialize any memory associated with the event.
Compatibility: 2.0 and higher
Contents |
Syntax
callback(int window_id, char *icontrol, "events_actionFromXMLStart", NULL, void *userData);
Note that all Trillian functions and notifications begin with a lower-case letter, despite the Wiki requirement that all pages start with a capital letter.
Parameters
Events actionFromXMLStart utilitizes the NONE structure.
There is no structure used for this function or notification. For functions, the parameter passed to plugin_send should be a NULL. For notifications, the 'data' field may still contain a parameter, but it will not be a structure; if so, it will be detailed below.
Nothing is passed to this notification.
Return Value
Return a pointer to the data object associated with the event. This will be passed to the events_actionFromXMLAttribute and events_actionFromXMLFinish notifications and whenever the action is executed.
Remarks
The data that is returned is sent to the events_actionDestroy when it is no longer needed, so you are not required to store this data that is returned.
See also: events_actionFromXMLFinish
