IChatChannelCallBack::OnChannelText

This event allows an extension to monitor all IRC and IRCX protocol messages sent to a specific channel.

Syntax

HRESULT OnChannelText(
   IChatChannel *Channel,
   IChatUser *User,
   IRC_COMMAND_TYPE Type,
   BSTR *Message,
   VARIANT_BOOL PostUpdate,
   long *Cancel);

Function IChatChannelCallBack_OnChannelText( _
   ByVal Channel As CHATSVCLib.IChatChannel, _
   ByVal User As CHATSVCLib.IChatUser, _
   ByVal Type As CHATSVCLib.IRC_COMMAND_TYPE, _
   ByRef Message As String, _
   ByVal PostUpdate As Boolean) As Long

Parameters

Channel

Reference to ChatChannel object to which Message is sent.

User

Reference to the ChatUser object representing the user who issued the message.

Type

Indicates the type of command as defined by the IRC_COMMAND_TYPE enumeration.

Message

The text of the message. The extension can modify Message during the pre-update notification.

PostUpdate

False if this is a pre-update notification. True if the channel text has been sent.

Cancel

Return value. Set to non-zero during the pre-update notification to cancel the operation.

Remarks

Protocol messages addressed to multiple channels will trigger this notification for each channel. The pre-update notification allows the extension to either change or cancel the channel message.

Whispered messages between users do not trigger OnChannelText notifications.

See Also

OnPrivateText

© 1998 Microsoft Corporation. All rights reserved.