AddUserEvent Method

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

Syntax

retVal = IChatRegistrar.AddUserEvent(EventName, User) 

Parameters

EventName

A comma-separated list of case-insensitive names matching IChatUserCallback methods, or an empty string representing a binding to all user event notifications. See remarks.

User

A reference to the ChatUser 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, "onuserpropertychanged,ONAWAYCHANGED" will create bindings to the IChatUserCallBack::OnUserPropertyChanged and IChatUserCallBack::OnAwayChanged methods of the extension.

Passing an empty string for EventName creates a binding for all user events. Passing NULL (or Nothing, in Visual Basic) for User causes the named events to be bound for all users. Passing an empty string for EventName and NULL for User creates a binding to all events for every user 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.