Windows Messenger Client Reference

This documentation provides information about the Microsoft Windows Messenger API which is a set of interfaces for objects related to the Messenger client. These APIs expose standard automation, messaging, and window management functionality.

The Messenger interfaces include the basic object interface; several interfaces that house entities such as users, windows, and lists; and an event sink (connection point) interface.

Enums

BASICIM_Constants

Not currently supported.

BIMSTATE

Specifies local or remote client state.

Note  The BIMSTATE enumerated type is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use MISTATUS instead.

BIMUSERPROPERTY

Not currently supported.

FONTSIZE

Not currently supported.

INFOBAR

Not currently supported.

MCONNECTIONTYPE

Not currently supported.

MCONTACTPROPERTY

Used to ask for the property that indicates which groups a user belongs to, or the contact's e-mail address.

MFILETRANSFER_FLAGS

Not currently supported.

MFIRSTTIME_FLAGS

Not currently supported.

MFOLDER

Not currently supported.

MINVITE_FLAGS

Not currently supported.

MISTATUS

Specifies local or remote client state. The user can select these options from the File menu of the Messenger window or by clicking the Messenger icon in the taskbar. The current state of the local user is detected on the local client. The current state of the remote clients is detected through the server automatically. Not all states are valid for remote clients.

MLIST

Used to retrieve information about contact lists.

Note  The MLIST enumerated type is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger.

MLOCALOPTION

Not currently supported.

MLOCALOPTION_LIMITS

Not currently supported.

MMESSENGERPROPERTY

Used to retrieve the Messenger client version and client locale ID (LCID).

MMSGPRIVACY

Not currently supported.

MMSGTYPE

Not currently supported.

MOPTDLGPAGE

Specifies which page of the Messenger client

MOPTIONPAGE

Specifies which page of the Messenger client

MPFLFIELD

Not currently supported.

MPHONE_TYPE

Specifies which phone number of a given contact is used.

MPROMPT

Not currently supported.

MPROXYTYPE

Not currently supported.

MSERVICE_FLAGS

Not currently supported.

MSERVICEPROPERTY

Used to ask for the property of a service.

MSGRConstants

The following are constants used for error and success returns of methods and properties of the Windows Messenger

MSGRConstants

The following are constants used for error or success returns of methods and properties of the Windows Messenger

MSTATE

Specifies local or remote client state.

Note  The MSTATE enumerated type is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use MISTATUS instead.

MSVCSTATUS

Not currently supported.

MUAFOLDER

Used for selecting the folder for the count of unread messages.

MUASORT

Specifies how the Contact List should be sorted.

MUPDATE_FLAGS

Not currently supported.

MURLTYPE

Not currently supported.

MUSERPROPERTY

Not currently supported.

MWINDOWPROPERTY

Used to turn on or off the conversation window sidebar and toolbar.

SSTATE

Not currently supported.

VOICESESSIONSTATE

Not currently supported.

DispInterfaces

DBasicIMEvents

The DBasicIMEvents dispinterface handles events that are generated or received by a BasicIMObject object.

Note  The DBasicIMEvents dispinterface is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use DMessengerEvents instead.

DMessengerAppEvents

The DMessengerAppEvents dispinterface handles events that are generated or received by a MessengerApp object.

DMessengerEvents

The DMessengerEvents dispinterface handles events that are generated or received by a Messenger object.

DMsgrObjectEvents

The DMsgrObjectEvents dispinterface handles events that are generated or received by a MsgrObject object.

Note  The DMsgrObjectEvents dispinterface is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use DMessengerEvents instead.

Events

DMsgrObjectEvents::OnAppInviteAccepted

Not currently supported.

DMsgrObjectEvents::OnAppInviteCancelled

Not currently supported.

DMsgrObjectEvents::OnAppInviteReceived

Not currently supported.

DBasicIMEvents::OnAppShutdown

Not currently supported.

DMessengerEvents::OnAppShutdown

Indicates that the client application is about to shut down for purposes of a client upgrade initiated either by the server or client user.

DMsgrObjectEvents::OnAppShutDown

Not currently supported.

DMessengerAppEvents::OnBeforeLaunchIMUI

Not currently supported.

DMsgrObjectEvents::OnBuddyPropertyChangeResult

Not currently supported.

DMessengerEvents::OnContactAddedToGroup

Indicates that a contact has been added to a group.

DMessengerEvents::OnContactBlockChange

Indicates that the block settings of a contact in the local client's Contact List have changed. Queries whether the contact is blocked by the local client user.

DMessengerEvents::OnContactFriendlyNameChange

Indicates that a contact in the client's Contact List has changed the friendly name.

DMessengerEvents::OnContactListAdd

Indicates the result of an attempt to add to the Messenger object's Contact List.

DBasicIMEvents::OnContactListAddResult

Not currently supported.

DMessengerEvents::OnContactListRemove

Indicates the result of an attempt to remove a contact from the Messenger object's Contact List.

DBasicIMEvents::OnContactListRemoveResult

Not currently supported.

DMessengerEvents::OnContactPagerChange

Indicates that a contact in the local client's Contact List has changed the pager information access permissions.

DMessengerEvents::OnContactPhoneChange

Indicates that the phone information of a contact in the local client's Contact List has changed.

DMessengerEvents::OnContactPropertyChange

Indicates that property information for a contact in the local client's Contact List has changed.

DMessengerEvents::OnContactRemovedFromGroup

Indicates that a contact has been removed from a group.

DMessengerEvents::OnContactStatusChange

Indicates that the status of a contact in the local client's Contact List has changed, and returns the current state of the contact.

DMessengerAppEvents::OnDestroyIMUI

Not currently supported.

DMsgrObjectEvents::OnFileTransferCancelled

Not currently supported.

DMessengerAppEvents::OnFileTransferIMUI

Not currently supported.

DMsgrObjectEvents::OnFileTransferInviteAccepted

Not currently supported.

DMsgrObjectEvents::OnFileTransferInviteCancelled

Not currently supported.

DMsgrObjectEvents::OnFileTransferInviteReceived

Not currently supported.

DMsgrObjectEvents::OnFileTransferStatusChange

Not currently supported.

DMsgrObjectEvents::OnFindResult

Not currently supported.

DMessengerEvents::OnGroupAdded

Indicates that a new group has been created.

DMessengerEvents::OnGroupNameChanged

Indicates that the name of a group has been changed.

DMessengerEvents::OnGroupRemoved

Indicates that a group has been deleted.

DMessengerEvents::OnIMWindowContactAdded

Indicates that a contact has been added to the ongoing conversation.

DMessengerEvents::OnIMWindowContactRemoved

Indicates that a contact has been removed from the ongoing conversation.

DMessengerEvents::OnIMWindowCreated

Indicates that a new conversation window has been opened.

DMessengerEvents::OnIMWindowDestroyed

Indicates that a new conversation window has been closed.

DMessengerAppEvents::OnIndicateMessageReceivedIMUI

Not currently supported.

DMessengerAppEvents::OnInfobarTextIMUI

Not currently supported.

DMsgrObjectEvents::OnInviteMailResult

Not currently supported.

DMsgrObjectEvents::OnInviteUser

Not currently supported.

DMsgrObjectEvents::OnListAddResult

Indicates the result of an attempt to add to the Messenger User object's User List.

Note  The DMsgrObjectEvents::OnListAddResult event is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use DMessengerEvents::OnContactListAdd instead.

DMsgrObjectEvents::OnListRemovedResult

Indicates the result of an attempt to remove a user from the Messenger User object's User List.

Note  The DMsgrObjectEvents::OnListRemovedResult event is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use DMessengerEvents::OnContactListRemove instead.

DMsgrObjectEvents::OnLocalFriendlyNameChangeResult

Indicates that the settings of a user in the local client's User List have changed.

Note  The DMsgrObjectEvents::OnLocalFriendlyNameChangeResult event is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use DMessengerEvents::OnMyFriendlyNameChange instead.

DMsgrObjectEvents::OnLocalPropertyChangeResult

Not currently supported.

DBasicIMEvents::OnLocalStateChangeResult

Not currently supported.

DMsgrObjectEvents::OnLocalStateChangeResult

Indicates that the status of the local client has been changed or that a status change was attempted.

Note  The DMsgrObjectEvents::OnLocalStateChangeResult event is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use DMessengerEvents::OnMyStatusChange instead.

DBasicIMEvents::OnLogoff

Indicates that the logoff is complete.

Note  The DBasicIMEvents::OnLogoff event is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use DMessengerEvents::OnSignout instead.

DMsgrObjectEvents::OnLogonoff

Not currently supported.

DBasicIMEvents::OnLogonResult

Not currently supported.

DMsgrObjectEvents::OnLogonResult

Indicates that an attempt has been made to sign in to the primary service.

Note  The DMsgrObjectEvents::OnLogonResult event is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use DMessengerEvents::OnSignin instead.

DMsgrObjectEvents::OnMessagePrivacyChangeResult

Not currently supported.

DMessengerAppEvents::OnMicrophoneMuteIMUI

Not currently supported.

DMessengerEvents::OnMyFriendlyNameChange

Indicates that the local client's friendly name has been changed or that a change was attempted.

DMessengerEvents::OnMyPhoneChange

Indicates that the local client's phone contact information has been changed or that a change was attempted.

DMessengerEvents::OnMyPropertyChange

Indicates that an uncategorized element of the local client's property information has been changed or that a change was attempted.

DMessengerEvents::OnMyStatusChange

Indicates that the status of the local client has changed or that a status change was attempted, and returns the current status of the local client.

DMsgrObjectEvents::OnNewerClientAvailable

Not currently supported.

DMsgrObjectEvents::OnNewSessionRequest

Not currently supported.

DMsgrObjectEvents::OnNotificationReceived

Not currently supported.

DMsgrObjectEvents::OnPrimaryServiceChanged

Not currently supported.

DMsgrObjectEvents::OnPromptChangeResult

Not currently supported.

DMsgrObjectEvents::OnRequestURLPostResult

Not currently supported.

DMsgrObjectEvents::OnRequestURLResult

Not currently supported.

DMessengerAppEvents::OnSendEnabledIMUI

Not currently supported.

DMsgrObjectEvents::OnSendResult

Not currently supported.

DMsgrObjectEvents::OnServiceLogonoff

Not currently supported.

DMsgrObjectEvents::OnSessionStateChange

Not currently supported.

DMessengerAppEvents::OnShowIMUI

Not currently supported.

DMessengerEvents::OnSignin

Indicates that an attempt has been made to sign in to the primary service.

DMessengerEvents::OnSignout

Indicates that the local client has signed out of the primary service.

DMsgrObjectEvents::OnSPMessageReceived

Not currently supported.

DMessengerAppEvents::OnStatusTextIMUI

Not currently supported.

DMsgrObjectEvents::OnTextReceived

Indicates that a message has been received.

Note  The DMsgrObjectEvents::OnTextReceived event is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger.

DMessengerAppEvents::OnTitlebarTextIMUI

Not currently supported.

DMsgrObjectEvents::OnTrustChanged

Not currently supported.

DMessengerEvents::OnUnreadEmailChange

Indicates the number of unread e-mail messages in the Messenger client's correlated MSN Hotmail Inbox that have changed from the last count of previous DMessengerEvents::OnUnreadEmailChange events or initial sign-in.

DMsgrObjectEvents::OnUnreadEmailChanged

Not currently supported.

DMsgrObjectEvents::OnUserDropped

Not currently supported.

DBasicIMEvents::OnUserFriendlyNameChangeResult

Not currently supported.

DMsgrObjectEvents::OnUserFriendlyNameChangeResult

Indicates that a user in the User List has changed his or her friendly name.

Note  The DMsgrObjectEvents::OnUserFriendlyNameChangeResult event is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use DMessengerEvents::OnContactFriendlyNameChange instead.

DMsgrObjectEvents::OnUserJoin

Not currently supported.

DMsgrObjectEvents::OnUserLeave

Not currently supported.

DBasicIMEvents::OnUserStateChanged

Indicates that the user's state has changed.

Note  The DBasicIMEvents::OnUserStateChanged event is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use DMessengerEvents::OnContactStatusChange instead.

DMsgrObjectEvents::OnUserStateChanged

Not currently supported.

DMessengerAppEvents::OnVoiceSessionStateIMUI

Not currently supported.

Interfaces

IBasicIM

Not currently supported.

IBasicIMOld

Messenger Basic IM Object Interface - old version.

Note  The IBasicIMOld interface is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use IMessenger instead.

IBasicIMUser

Messenger User for an OE Private interface.

Note  The IBasicIMUser interface is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use IMessenger instead.

IBasicIMUser2

Not currently supported.

IBasicIMUsers

Not currently supported.

IMessenger

The primary interface for Windows Messenger APIs calls. Includes methods for displaying Messenger client

IMessenger2

The secondary interface for the Windows Messenger API calls.

IMessenger3

The third interface for the Windows Messenger API calls.

IMessengerApp

The IMessengerApp interface provides methods and properties to handle Messenger applications.

Note  The IMessengerApp interface is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use IMessenger instead.

IMessengerApp2

Not currently supported.

IMessengerApp3

Not currently supported.

IMessengerContact

The primary interface for an individual MessengerContact object (the local representation of a remote user). Each contact in the contact list exists as its own MessengerContact object.

IMessengerContacts

An interface that manipulates the contact list, which maintains a collection of users in a Messenger object.

Any MessengerContacts collection object can have zero members in its collection.

List collection objects are not explicitly created or destroyed. They already exist and were created by the Messenger object. To create a pointer to the existing object that represents the Contact List, use the IMessenger::GetContact method.

IMessengerConversationWnd

An interface that returns an IDispatch  pointer to an IMessengerContacts collection that contains the participants of that conversation, excluding the local user. This is a read-only collection. IMessengerGroups::Remove cannot be used on this collection.

IMessengerGroup

The IMessengerGroup interface provides methods and properties to handle a group's collection of users.

IMessengerGroups

The IMessengerGroups interface provides methods and properties to handle groups of users.

IMessengerIMWindow

Not currently supported.

IMessengerIMWindows

Not currently supported.

IMessengerService

The primary interface for an individual MessengerService object.

IMessengerServices

Manipulates the list of services.

IMessengerWindow

The automation interface for a Messenger window.

IMsgrHost

Not currently supported.

IMsgrIMSession

Not currently supported.

IMsgrIMSessions

Not currently supported.

IMsgrObject

The IMsgrObject interface provides methods and properties to handle the Messenger Object.

Note  The IMsgrObject interface is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use IMessenger instead.

IMsgrObject2

Not currently supported.

IMsgrPassportClient

Not currently supported.

IMsgrService

Not currently supported.

IMsgrServices

Not currently supported.

IMsgrSP

Not currently supported.

IMsgrSP2

Not currently supported.

IMsgrUser

Not currently supported.

IMsgrUser2

Not currently supported.

IMsgrUsers

The IMsgrUsers interface provides methods and properties to handle the Messenger User object.

Note  The IMsgrUsers interface is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use IMessengerContacts instead.

IMsgrWebScriptManager

Not currently supported.

IMsnMessengerIMWindow

Not currently supported.

IMsnMessengerIMWindow2

Not currently supported.

Objects

BasicIMObject

The Windows Messenger Basic Instant Messaging Service (IM) object.

Note  The BasicIMObject object is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use Messenger instead.

Messenger

The Messenger object implements the IMessenger3 interface and DMessengerEvents dispinterface. This object maintains lists of users and performs most automation functions.

MessengerApp

Not currently supported.

MessengerContact

The MessengerContact object corresponds to the IMessengerContact interface. This object provides a local representation of a remote contact. It represents a single user as stored in the Messenger object's internal contact list.

MessengerContacts

The MessengerContacts object corresponds to the IMessengerContacts interface. It is a collection object of contacts in the contact list.

MessengerConversationWnd

The MessengerConversationWnd object corresponds to the IMessengerConversationWnd interface.

MessengerGroup

The MessengerGroup object corresponds to the IMessengerGroup interface. It represents a single group as stored in the Messenger object's internal group list.

MessengerGroups

The MessengerGroups corresponds to the IMessengerGroups interface. It is a collection object of groups in the contact list.

MessengerNative

This is the native messenger object.

MessengerService

The MessengerService object corresponds to the IMessengerService interface. This object represents a single service.

MessengerServices

The MessengerServices corresponds to the IMessengerServices interface. It represents a list of services in the Messenger object.

MessengerWindow

The MessengerWindow object corresponds to the IMessengerWindow interface. This object can represent either the main application window or a conversation window that contains one or more active sessions between contacts and the local client user.

MsgrObject

The MsgrObject object.

Note  The MsgrObject object is available for use in Windows Messenger 4.7. It might be altered or unavailable in subsequent versions of Windows Messenger. You should use Messenger and MessengerContacts instead.

Structures

LOGFONT_DATA

Not currently supported.