IMsgrSession::Invite method

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

Invites a user to the current session.

Syntax

HRESULT Invite(
  [in] IDispatch *pUser,
  [in] BSTR      bstrAppData
);

pUser [in]

Type: IDispatch*

Pointer to an IDispatch of a MessengerContact object representing the user that is invited to the session.

bstrAppData [in]

Type: BSTR

BSTR that specifies the application specific data. bstrAppData has a limit of 512 bytes.

Type: HRESULT

Returns one of the following values.

Return code	Description
S_OK	The invitation was sent successfully.
E_INVALIDARG	One of the values passed into the method was not valid.
SR_APP_NOT_SPECIFIED	The application was not specified.
SR_SESSION_NOT_READY	The session is not ready.
MSGR_E_NOT_LOGGED_ON	The invited user is not logged on.
SR_INVITED_SELF	The inviter and invitee are the same user.

The following table lists the error codes returned by this method.

Error Code	Meaning
0x80070057	One of the values passed into the method was not valid.
0x8100031e	The invited user is not logged on.
SR_SESSION_NOT_READY (0x81000605)	The session is not ready.
SR_APP_NOT_SPECIFIED (0x81000610)	The application was not specified.
SR_INVITED_SELF (0x81000613)	The inviter and invitee are the same user.


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.0
Header	Msgrpriv.h
IDL	Msgrpriv.idl
DLL	Msgsc.dll