KeyboardAliasUnregister

From TrillWiki

Removes a registered alias. This must be done for all registered aliases.

Compatibility: 1.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID, "keyboardAliasUnregister", struct keyboard_alias_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

KeyboardAliasUnregister utilitizes the keyboard_alias_t structure.

struct keyboard_alias_t { 
 	unsigned int   			struct_size; 
 
 	int				alias_id; 
 
 	int				alt; 
 	int				ctrl; 
 	int				shift; 
 
 	char				key; 
 
 	ttkCallback			callback; 
 	void				*data; 
 };

alias_id

The alias ID returned from keyboardAliasRegister for the particular alias you wish to remove.

Return Value

Returns a negative value on error, 0 on success.

Remarks

This function must be called for every alias that is registered using keyboardAliasRegister. If it is not, Trillian may crash.