Share via


DMsgrSessionManagerEvents::OnInvitation event

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

Fires when a new session invitation has been received.

Syntax

void OnInvitation(
  [in]      IDispatch    *pSession,
  [in]      BSTR         bstrAppData,
  [in, out] VARIANT_BOOL *pfHandled = VARIANT_FALSE
);

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 Invite method.

pfHandled [in, out]

Pointer to a VARIANT_BOOL that defines one of the following possible values.

Value Meaning
VARIANT_FALSE
false
An invitation was received and a Windows Messenger conversation window will be opened.
VARIANT_TRUE
true
An invitation was received, but a Windows Messenger conversation window will not be opened.

Return value

This event does not return a value.

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.

Requirements

Minimum supported client
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
Msgrpriv.h (include Mdispid.h)
IDL
Msgrpriv.idl
DLL
Msnmsgrexe.adeb440d_7847_4f65_80bd_899870ed2ec9

See also

DMsgrSessionManagerEvents

OnAppRegistered

OnAppShutdown

OnAppUnRegistered

BeforeAppLaunch

Invite

Messenger Session Invite and Messenger Private APIs

Messenger Lock and Key API