DMessengerPrivateEvents::OnLockEnable Event

  • Article

Deprecated. Notifies a Messenger client with the status of the Messenger Lock and Key APIs.

Syntax

void OnLockEnable(      
    VARIANT_BOOL fEnable
);

Parameters

  • fEnable
    [in] VARIANT_BOOL that defines one of the following possible values.
    • VARIANT_FALSE
      Lock and Key is disabled.
    • VARIANT_TRUE
      Default. Lock and Key is enabled.

Return Value

No return value.

Event DISPID

DISPID_ONLOCKENABLE

The DISPID for this event is defined in msgrpriv.h. Use this value to identify the event handler when implementing IDispatch::Invoke.

Remarks

This event fires shortly after a user signs in to Microsoft Windows Messenger and indicates whether the Messenger client can proceed to request an authentication challenge from the Messenger service. Until this event notification is received, a Messenger client cannot unlock the Messenger service APIs and requests for an authentication challenge will fail.

Important  DMessengerPrivateEvents::OnLockEnable is no longer available in Windows Vista. See Windows Messenger for more information.

See Also

DMessengerPrivateEvents::OnAlertReceived, DMessengerPrivateEvents::OnLockChallenge, DMessengerPrivateEvents::OnLockResult, IMsgrLock::RequestChallenge, IMsgrLock::SendResponse, Messenger Lock and Key API, Messenger Session Invite and Messenger Private APIs