EventsActionUnregister

From TrillWiki

Jump to: navigation, search

The eventsActionUnregister function will unregister an action that has been registered using the eventsActionRegister function.

Compatibility: 2.0 and higher

Contents

Syntax

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

EventsActionUnregister 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; 
 };



event
The event that was registered.
event_id
The id of the event action returned with eventsActionRegister.
custom_settings
Set this to the same value that it was set to in the call to eventsActionRegister.


Return Value

Negative value on error, 0 on success.

Remarks

None.