PeerCollabGetInvitationResponse function (p2p.h)

  • Article

The PeerCollabGetInvitationResponse function obtains the response from a peer previously invited to join a peer collaboration activity.

Syntax

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabGetInvitationResponse(
  [in]  HANDLE                    hInvitation,
  [out] PPEER_INVITATION_RESPONSE *ppInvitationResponse
);

Parameters

[in] hInvitation

Handle to an invitation to join a peer collaboration activity.

[out] ppInvitationResponse

Pointer to the address of a PEER_INVITATION_RESPONSE structure that contains an invited peer's response to a previously transmitted invitation request.

Free the memory associated with this structure by calling PeerFreeData.

Return value

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

Return code Description
E_INVALIDARG
 The provided handle is invalid.
E_OUTOFMEMORY
 There is not enough memory to support this operation.
PEER_E_NOT_FOUND
 The invitation recipient could not be found.
PEER_E_INVITE_CANCELED
 The invitation was previously canceled.
PEER_E_INVITE_RESPONSE_NOT_AVAILABLE
 The response to the peer invitation is not available.
PEER_E_CONNECTION_FAILED
 A connection to the graph or group has failed, or a direct connection in a graph or group has failed.

Remarks

This function must be called after PeerCollabAsyncInviteContact or PeerCollabAsyncInviteEndpoint is called and the event handle provided to PeerCollabRegisterEvent is signaled on the peer that sent the invitation.

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

See also

PEER_INVITATION_RESPONSE

Peer Collaboration API Functions

PeerCollabAsyncInviteContact

PeerCollabAsyncInviteEndpoint