Microsoft Chat Server SDK Reference

IChatUserCallBack::OnAwayChanged

This notification indicates that the user's away text is changing.

Syntax

C/C++:
HRESULT OnAwayChanged(
   IChatUser *User,
   BSTR *Away,
   VARIANT_BOOL PostUpdate,
   long *Cancel);
Visual Basic:
Function IChatUserCallBack_OnAwayChanged( _
   ByVal User As CHATSVCLib.IChatUser, _
   ByRef Away As String, _
   ByVal PostUpdate As Boolean) As Long

Parameters

User
Reference to the ChatUser object representing the user.
Away
The text of the away message. The extension can modify Away during the pre-update notification.
PostUpdate
False if this is a pre-update notification. True if the user away text has 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 away message based on its content. To clear the away message, set Away to the empty string ("") during the pre-update notification.

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


© 1998 Microsoft Corporation. All rights reserved.