Share via


DMsgrSessionManagerEvents::OnLockEnable event

[OnLockEnable is no longer available for use as of Windows Vista. See Windows Messenger for more information.]

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

Syntax

void OnLockEnable(
  [in] VARIANT_BOOL fEnable = VARIANT_TRUE
);

Parameters

fEnable [in]

VARIANT_BOOL that defines one of the following possible values.

Value Meaning
VARIANT_FALSE
false
Lock and Key is disabled.
VARIANT_TRUE
true
Lock and Key is enabled.

Return value

This event does not return a value.

Remarks

This event fires shortly after a user signs in to 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.

Requirements

Minimum supported client
Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
End of client support
Windows XP
End of server support
Windows Server 2003
Product
Messenger 4.5
Header
Sessions.h (include Mdispid.h)
IDL
Sessions.idl
DLL
Msnmsgrexe.adeb440d_7847_4f65_80bd_899870ed2ec9

See also

DMsgrSessionManagerEvents

OnLockChallenge

OnLockResult

Messenger Session Invite and Messenger Private APIs

Messenger Lock and Key API