PeerCollabGetAppLaunchInfo function (p2p.h)

Article
02/22/2024

The PeerCollabGetAppLaunchInfo function obtains the peer application launch information, including the contact name, the peer endpoint, and the invitation request.

Syntax

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabGetAppLaunchInfo(
  [out] PPEER_APP_LAUNCH_INFO *ppLaunchInfo
);

Parameters

[out] ppLaunchInfo

Pointer to a PEER_APP_LAUNCH_INFO structure that receives the peer application launch data.

Free the memory associated with this structure by passing it to PeerFreeData.

Return value

Returns S_OK if the function succeeds. Otherwise, the function returns one of the following values.

Return code	Description
E_OUTOFMEMORY	There is not enough memory to support this operation.
E_INVALIDARG	One of the arguments is invalid.
PEER_E_NOT_FOUND	The requested data does not exist.

Remarks

When an application invite is accepted, the application is launched with the information sent as part of the application invite. This information can be obtained by calling PeerCollabGetAppLaunchInfo.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	p2p.h
Library	P2P.lib
DLL	P2P.dll