IChatUserCallBack::OnNickChanged

This notification indicates that a user is attempting to change his or her nickname.

Syntax

HRESULT OnNickChanged(
   IChatUser *User,
   BSTR *Nick,
   VARIANT_BOOL PostUpdate,
   long *Cancel);

Function IChatUserCallBack_OnNickChanged( _
   ByVal User As CHATSVCLib.IChatUser, _
   ByRef Nick As String, _
   ByVal PostUpdate As Boolean) As Long

Parameters

User

Reference to the ChatUser object representing the user.

Nick

The text of the user's new nickname. The extension can modify Nick during the pre-update notification.

PostUpdate

False if this is a pre-update notification. True if the nickname has been changed.

Cancel

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

Remarks

An extension can use this notification to allow or disallow the new nickname based on its content.

When this property changes, the OnUserPropertyChanged method is not called. Extensions that are interested in the OnNickChanged event should register for this notification explicitly.

© 1998 Microsoft Corporation. All rights reserved.