EventsEventUpdate

From TrillWiki

Jump to: navigation, search

The eventsEventUpdate function will update an already registered event. This function is most often used to update the description on language change.

Compatibility: 2.0 and higher

Contents

Syntax

plugin_send(MYGUID, "eventsEventUpdate", struct event_event_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

EventsEventUpdate utilitizes the event_event_register_t structure.

struct event_event_register_t {  
 	unsigned int			struct_size; 
 
 	char				*type; 
 	char				*description; 
 };


type
The event type. This will be consistent no matter which language is used.
description
The updated description for the particular event.


Return Value

Negative value on error, 0 on success.

Remarks

None.