DMsgrSessionManagerEvents::OnInvitation Event

  • Article

Deprecated. Fires when a new session invitation has been received.

Syntax

void OnInvitation(      
    IDispatch *pSession,
    BSTR bstrAppData,
    VARIANT_BOOL *pfHandled
);

Parameters

  • pSession
    [in] Pointer to an IDispatch interface that corresponds to the application session.
  • bstrAppData
    [in] BSTR equal to the value defined by the application when the session invitation was made using the IMsgrSession::Invite method.
  • pfHandled
    [in, out] Pointer to a VARIANT_BOOL that defines one of the following possible values.
    • VARIANT_FALSE
      Default. An invitation was received and a Microsoft Windows Messenger conversation window will be opened.
    • VARIANT_TRUE
      An invitation was received, but a Windows Messenger conversation window will not be opened.

Return Value

No return value.

Event DISPID

DISPID_ONINVITATION

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

Remarks

When the Messenger client receives an invitation, the default value of pfHandled will be VARIANT_FALSE. If the user sets the value to VARIANT_TRUE, then the Messenger client receiving the invitation will not have the conversation window open.

Important  DMsgrSessionManagerEvents::OnInvitation is no longer available in Windows Vista. See Windows Messenger for more information.

See Also

DMsgrSessionManagerEvents::OnAppRegistered, DMsgrSessionManagerEvents::OnAppShutdown, DMsgrSessionManagerEvents::OnAppUnRegistered, DMsgrSessionEvents::BeforeAppLaunch, IMsgrSession::Invite, Messenger Session Invite and Messenger Private APIs, Messenger Lock and Key API