Windows Messenger Service Reference

[Windows Messenger is no longer available for use as of Windows Vista. For more information, see Windows Messenger.]

This is the entry page to the reference documentation for the Messenger service APIs.

New applications should not use this set of interfaces. These interfaces exist for backward compatibility with legacy applications. These interfaces will be unavailable in the future.

Applications cannot connect to Microsoft .NET Messenger Service or use any of the Messenger service APIs until they have successfully authenticated with the Messenger Lock and Key mechanism. After authentication is complete, the Messenger service APIs are unlocked and can be used as necessary by the application.

The Messenger service API references are provided for Microsoft Visual C++. Also there is an overview included (Messenger Lock and Key API), that provides general guidelines on unlocking and using the Messenger service APIs.

Enums

LockErrorDo not use. Provides a list of Lock and Key error status codes.
LockStatusDo not use. Provides the list of possible status codes for the Messenger Lock and Key API.
SESSION_STATEDo not use. Provides the list of possible state codes of the session invitation.
SESSION_FLAGSDo not use. Provides the list of possible flag codes for the session invitation.
SESSION_RESULTDo not use. Provides the list of possible result codes of the session invitation.

Events

OnAlertReceivedFires when an alert notification is sent from a Messenger service to a Messenger client application.
OnContactListAddNotifies a Messenger client that a contact has been added to the contact list.
OnLockChallengeNotifies a Messenger client that an authentication challenge from a Messenger service has been received.
OnLockEnableNotifies a Messenger client with the status of the Messenger Lock and Key APIs.
OnLockResultReturns the result of a Lock and Key authentication transaction between a Messenger client and the Microsoft .NET Messenger Service.
BeforeAppLaunchFires when the session's application is about to be launched.
OnAcceptedFires when the recipient has accepted the invitation.
OnAppNotPresentFires when the application requested by the invitation is not present.
OnCancelledFires when the session has been canceled by the inviter.
OnContextDataFires when new context data has arrived.
OnDeclinedFires when the recipient has declined the invitation.
OnReadyToLaunchFires when the session is approved to start.
OnSendErrorFires when the last operation fails when sending.
OnStateChangedFires when the session state has changed from the previous state.
OnTerminationFires when the session has ended.
OnAppRegisteredFires when a new application has been registered.
OnAppShutdownFires when Windows Messenger is shutting down.
OnAppUnRegisteredFires when an application has been unregistered.
OnInvitationFires when a new session invitation has been received.
OnLockChallengeNotifies a Messenger client that an authentication challenge from a Messenger service has been received.
OnLockEnableNotifies a Messenger client with the status of the Messenger Lock and Key APIs.
OnLockResultReturns the result of a Lock and Key authentication transaction between a Messenger client and the Microsoft .NET Messenger Service.
OnLockStatusChangedFires when the lock status changes.

DispInterfaces

DMessengerPrivateEventsDo not use. The DMessengerPrivateEvents dispinterface fires events in the Messenger client when notifications from IMessengerPrivate are received.
DMsgrSessionEventsDo not use. The DMessengerPrivateEvents dispinterface fires events in the Messenger client when notifications from IMsgrSession are received.
DMsgrSessionManagerEventsDo not use. The DMsgrSessionManagerEvents dispinterface fires events in the Messenger client when notifications from IMsgrSessionManager are received.

Interfaces

IMessengerPrivateDo not use. The IMessengerPrivate interface is a Messenger service API that provides programmatic access to the MessengerPriv object.
IMsgrLockDo not use. The IMsgrLock interface implements an API that is used to unlock Licensed Messenger objects.
IMsgrSessionDo not use. The IMsgrSession interface provides programmatic access to the MsgrSession object.
IMsgrSessionManagerDo not use. The IMsgrSessionManager interface is a Messenger service API that provides programmatic access to the MsgrSessionManager object.

Objects

MessengerPrivDo not use. The Messenger service MessengerPriv object.
MsgrSessionDo not use. The Messenger client session object.
MsgrSessionManagerDo not use. The Messenger client session manager object.