MessageBroadcastDisable

From TrillWiki

Stop a message broadcast. This is usually called in the "stop" notification or whenever a plugin no longer wishes to receive IM's.

Compatibility: 1.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

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

MessageBroadcastDisable utilitizes the message_broadcast_t structure.

struct message_broadcast_t {  
 	unsigned int			struct_size;  
 
 	int					broadcast_id;  
 
 	ttkCallback				callback;  
 	void				*data;  
 };

broadcast_id

The broadcast ID returned by messageBroadcastEnable.

Return Value

Negative value on error, 0 on success.

Remarks

This must be called for everytime a messageBroadcastEnable is called. It should be called in the "stop" of a plugin.

See also: Message Notifications