EventsEventRegister

From TrillWiki

Jump to: navigation, search

The eventsEventRegister function will register for a particular event type that could be generated at some point in the future. This will provide Trillian with the event before its generated so that it can put it within the advanced section of preferences and the user can set up actions to trigger when its generated.

Compatibility: 2.0 and higher

Contents

Syntax 

plugin_send(MYGUID, "eventsEventRegister", 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

EventsEventRegister 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 description of the event. This may change when the language is changed.


Return Value

Negative value on error, 0 on success.

Remarks

Be sure to call eventsEventUnregister when the plugin is stopped.


Retrieved from "http://developer.ceruleanstudios.com/index.php/EventsEventRegister"