Share via


IMsgrSessionManager::GetLaunchingSession method

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

Retrieves the session information that started the application.

Syntax

HRESULT GetLaunchingSession(
  [in]          LONG      lProcessID,
  [out, retval] IDispatch **ppSession
);

Parameters

lProcessID [in]

Type: LONG

LONG that specifies the process ID of the process.

ppSession [out, retval]

Type: IDispatch**

Address of a pointer to an IDispatch interface that returns the MsgrSession object.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
The session information was retrieved successfully.
E_INVALIDARG
One of the parameters passed to the method was not valid.
E_FAIL
The session information cannot be retrieved due to a catastrophic error.

Remarks

Process IDs can be viewed from within the Task Manager.

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

Error Code Meaning
0x80004005 The session information cannot be retrieved due to a catastrophic error.
0x80070057 One of the parameters passed to the method was not valid.

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

See also

IMsgrSessionManager

MsgrSession

Messenger Session Invite and Messenger Private APIs

Messenger Lock and Key API