DMessengerPrivateEvents::OnAlertReceived Event

  • Article

Deprecated. Fires when an alert notification is sent from a Messenger service to a Messenger client application.

Syntax

void OnAlertReceived(      
    BSTR bstrAlert,
    VARIANT_BOOL *pBoolfEnableDefault
);

Parameters

  • bstrAlert
    [in] BSTR containing the alert notification message.
  • pBoolfEnableDefault
    [in, out] Pointer to a VARIANT_BOOL that defines one of the following possible values.
    • VARIANT_FALSE
      Alerts are disabled.
    • VARIANT_TRUE
      Default. Alerts are enabled.

Return Value

No return value.

Event DISPID

DISPID_MUAE_ONALERTRECEIVED

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

Remarks

A Messenger client receives this event if it has called the IMessengerPrivate::EnableAlertEvents method and one of the Messenger service sites that the application is connected to fires an alert.

The value of pBoolfEnableDefault indicates whether a popup window is displayed when this event is received. You must set this value to VARIANT_FALSE to specify that Microsoft Windows Messenger must not display a popup window for this alert; otherwise a popup window is displayed.

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

See Also

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