Microsoft Chat Server SDK Reference

AddChannelEvent Method

This method allows an extension to register for notifications specific to channel events.

Syntax

retVal = IChatRegistrar.AddChannelEvent(EventName, Channel) 

Parameters

EventName
A comma-separated list of case-insensitive names matching IChatChannelCallback methods, or an empty string representing a binding to all channel event notifications. See remarks.
Channel
A reference to the ChatChannel object for which the binding is requested, or NULL.
retVal
Return value. Zero for success, or error code to indicate failure.

Remarks

EventName can contain one or more event names. Case is not significant. For example, "onchannelpropertychanged,ONADDMEMBER" will create bindings to the IChatChannelCallBack::OnChannelPropertyChanged and IChatChannelCallBack::OnAddMember methods of the extension.

Passing an empty string for EventName creates a binding for all channel events. Passing NULL (or Nothing, in Visual Basic) for Channel causes the named events to be bound for all channels. Passing an empty string for EventName and NULL for Channel creates a binding to all events for every channel object.

The return code is zero if all bindings were successful. If any binding is unsuccessful, then none of the bindings take effect.


© 1998 Microsoft Corporation. All rights reserved.