EventsActionUpdate
From TrillWiki
The eventsActionUpdate function will update information related to an existing registered action. Most of the time this is used on a language change to update the description.
Compatibility: 2.0 and higher
Contents |
Syntax
plugin_send(MYGUID, "eventsActionUpdate", struct event_action_register_t *);
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
EventsActionUpdate utilitizes the event_action_register_t structure.
struct event_action_register_t {
unsigned int struct_size;
char *event;
char *description;
int custom_settings;
int event_id;
ttkCallback callback;
void *data;
};
- description
- The description of the event. This is a most likely the same as the event string in the main language and can change with a language change.
- custom_settings
- If this event needs more settings, it may be included in its own action setting. Set this to 1 if you have a dialog to go along with it within the advanced preferences screen.
- event_id
- The event id returned from the eventsActionRegister call.
- callback
- The callback to receive both the custom notifications and the event. The event will be sent as the 'event' variable of the callback. The user data will be an event_variable_t struct.
- data
- The data to send with the above callback.
Return Value
Negative value on error, 0 on success.
Remarks
None.
