Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The PeerCollabCancelInvitation function cancels an invitation previously sent by the caller to a contact.
Syntax
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabCancelInvitation(
[in] HANDLE hInvitation
);
Parameters
[in] hInvitation
Handle to a previously sent invitation.
Return value
Returns S_OK if the function succeeds. Otherwise, the function returns one of the following values.
Return code | Description |
---|---|
|
There is not enough memory to support this operation. |
|
The provided handle is invalid. |
|
The application did not make a previous call to PeerCollabStartup. |
|
The handle specified is invalid. |
Remarks
When PeerCollabCancelInvitation is called, depending on the state of the invitation, it will perform one or more of the following actions:
- If the connection to the receiver is not yet established, it will cancel the connection creation process and the receiver will not see the invitation.
- If the invitation has been received, but not responded to, it will notify the recipient contact that the invitation has been canceled. As a result, the receiver will not be able to respond to the invitation.
- If the receiver has already responded to the invitation, the call performs a no-op. After canceling the invitation, you must call PeerCollabCloseHandle.
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 |