IMsgrSession::Invite Method

Deprecated. Invites a user to the current session.


HRESULT Invite(      
    IDispatch *pUser,
    BSTR bstrAppData


  • pUser
    [in] Pointer to an IDispatch World Wide Web link of a MessengerContact object representing the user that is invited to the session.
  • bstrAppData
    [in] BSTR that specifies the application specific data. bstrAppData has a limit of 512 bytes.

Return Value

Returns one of the following values.

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.


Important  IMsgrSession::Invite is no longer available in Windows Vista. See Windows Messenger for more information.

See Also

IMsgrSession::Accept, IMsgrSession::Cancel, IMsgrSession::Decline, Messenger Session Invite and Messenger Private APIs, Messenger Lock and Key API