PluginCallBack Function

The PluginCallBack function is a plug-in defined exported callback function that all plug-ins are required to export. It processes messages sent to the plug-in. The PLUGIN_CALLBACK type defines a pointer to this callback function.

EXTERN EXPORT BOOL PluginCallBack(
	UINT	msg, 
	WPARAM	wParam, 
	LPARAM	lParam
);

Parameters

msg

The reason the callback is being called. This parameter can be one of the following values.

Value Meaning

PLGMSG_INITPLUGIN The plug-in is being loaded and needs to initialize some data.

PLGMSG_STARTPLUGIN The plug-in is has been accepted as a valid plug-in and can start its services.

PLGMSG_STOPPLUGIN The plug-in is about to be unloaded (or Babel is shutting down).

PLGMSG_DELPLUGIN The plug-in will be unloaded shortly.

PLGMSG_CONFPLUGIN The user wants to configure the plug-in.

COMPLGMSG_ADDBUDDY The user has ask to add a buddy.

COMPLGMSG_REMBUDDY The user has ask to remove a buddy.

COMPLGMSG_STATUS Babel is requesting to know the status of the plug-in.

COMPLGMSG_SENDMSG There is a chat message to send through the plug-in.

COMPLGMSG_GETUSERINFO Babel is requesting information abou the user that is using the plug-in.

COMPLGMSG_SEARCHFORUSER The plug-in has set its information to accept searches and the user is requesting a search.

COMPLGMSG_BUDDYMENU The plug-in has provided a buddy menu and an item from that menu has been selected.

CHATPLGMSG_RECVMSG The loaded chat dialog plug-in is being notified of a chat message that has been recieved.

CHATPLGMSG_RECVSYSMSG The loaded chat dialog plug-in is being notified of a system message that has been recieved.

HOOK_BUDDY_STATUS_CHANGE The plug-in has requested to be notified of buddy status changes, and the event has occured.

HOOK_MSG_INCOMING The plug-in has requested to be notified of incoming messages, and the event has occured.

HOOK_MSG_OUTGOING_AFTER The plug-in has requested to be notified of outgoing messages, and the event has occured.

HOOK_MSG_OUTGOING_BEFORE The plug-in has requested to be notified of outgoing messages, and the event has occured.

HOOK_PLUGIN_LOADED The plug-in has requested to be notified of plug-ins being loaded, and the event has occured.

HOOK_PLUGIN_UNLOADED The plug-in has requested to be notified of plug-ins being unloaded, and the event has occured.

HOOK_PLUGIN_STATUS_CHANGE The plug-in has requested to be notified of plug-in status changes, and the event has occured.

HOOK_BUDDY_NEW_SESSION The plug-in has requested to be notified of of new chat sessions initiated by the user, and the event has occured.

HOOK_SKIN_EVENT The plug-in has requested to be notified of unhandled skin events, and the event has occured.

wParam
Message specifc data (see the message for more information).

lParam
Message specifc data (see the message for more information).

Value	Meaning
PLGMSG_INITPLUGIN	The plug-in is being loaded and needs to initialize some data.
PLGMSG_STARTPLUGIN	The plug-in is has been accepted as a valid plug-in and can start its services.
PLGMSG_STOPPLUGIN	The plug-in is about to be unloaded (or Babel is shutting down).
PLGMSG_DELPLUGIN	The plug-in will be unloaded shortly.
PLGMSG_CONFPLUGIN	The user wants to configure the plug-in.
COMPLGMSG_ADDBUDDY	The user has ask to add a buddy.
COMPLGMSG_REMBUDDY	The user has ask to remove a buddy.
COMPLGMSG_STATUS	Babel is requesting to know the status of the plug-in.
COMPLGMSG_SENDMSG	There is a chat message to send through the plug-in.
COMPLGMSG_GETUSERINFO	Babel is requesting information abou the user that is using the plug-in.
COMPLGMSG_SEARCHFORUSER	The plug-in has set its information to accept searches and the user is requesting a search.
COMPLGMSG_BUDDYMENU	The plug-in has provided a buddy menu and an item from that menu has been selected.
CHATPLGMSG_RECVMSG	The loaded chat dialog plug-in is being notified of a chat message that has been recieved.
CHATPLGMSG_RECVSYSMSG	The loaded chat dialog plug-in is being notified of a system message that has been recieved.
HOOK_BUDDY_STATUS_CHANGE	The plug-in has requested to be notified of buddy status changes, and the event has occured.
HOOK_MSG_INCOMING	The plug-in has requested to be notified of incoming messages, and the event has occured.
HOOK_MSG_OUTGOING_AFTER	The plug-in has requested to be notified of outgoing messages, and the event has occured.
HOOK_MSG_OUTGOING_BEFORE	The plug-in has requested to be notified of outgoing messages, and the event has occured.
HOOK_PLUGIN_LOADED	The plug-in has requested to be notified of plug-ins being loaded, and the event has occured.
HOOK_PLUGIN_UNLOADED	The plug-in has requested to be notified of plug-ins being unloaded, and the event has occured.
HOOK_PLUGIN_STATUS_CHANGE	The plug-in has requested to be notified of plug-in status changes, and the event has occured.
HOOK_BUDDY_NEW_SESSION	The plug-in has requested to be notified of of new chat sessions initiated by the user, and the event has occured.
HOOK_SKIN_EVENT	The plug-in has requested to be notified of unhandled skin events, and the event has occured.

Return Values

Typically, the plug-in callback should return TRUE if it processed the message, and FALSE if it did not.

Function Information

Header plugin.h