EditAliasUnregister

From TrillWiki

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

Compatibility: 1.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

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

EditAliasUnregister utilitizes the alias_t structure.

struct alias_t { 
 	unsigned int   			struct_size; 
 
 	int     			alias_id; 
 
 	char				*text; 
 
 	ttkCallback			callback; 
 
 	void				*data; 
 };

alias_id

The alias ID returned from editAliasRegister

Return Value

Returns a negative value on error, 0 on success.

Remarks

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

See also: Alias Notifications