PeerCollabAsyncInviteEndpoint, fonction (p2p.h)

Article
03/06/2024

La fonction PeerCollabAsyncInviteEndpoint envoie une invitation à un point de terminaison d’homologue spécifié pour rejoindre l’activité de collaboration d’homologue de l’expéditeur. La disponibilité de la réponse à l’invitation est mise à jour via un événement asynchrone.

Syntaxe

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabAsyncInviteEndpoint(
  [in]            PCPEER_ENDPOINT   pcEndpoint,
  [in]            PCPEER_INVITATION pcInvitation,
  [in, optional]  HANDLE            hEvent,
  [out, optional] HANDLE            *phInvitation
);

Paramètres

[in] pcEndpoint

Pointeur vers une structure PEER_ENDPOINT qui contient des informations sur l’homologue invité. Cet homologue reçoit une invitation lorsque cette API est appelée.

Ce paramètre ne doit pas être défini sur NULL.

[in] pcInvitation

Pointeur vers une structure PEER_INVITATION qui contient la demande d’invitation à envoyer au point de terminaison spécifié dans pcEndpoint. E_INVALIDARG est retourné si ce paramètre a la valeur NULL.

[in, optional] hEvent

Gérez l’événement pour cette invitation, créée par un appel précédent à CreateEvent. L’événement est signalé lorsque le status de l’invitation asynchrone est mis à jour. Pour obtenir les données de réponse, appelez PeerCollabGetInvitationResponse.

Si l’événement n’est pas fourni, l’appelant doit interroger le résultat en appelant PeerCollabGetInvitationResponse.

[out, optional] phInvitation

Pointeur vers un handle vers l’invitation envoyée. Si ce paramètre a la valeur NULL, l’infrastructure nettoie les informations de réponse une fois la réponse d’invitation reçue. Si ce paramètre n’est pas NULL, le handle doit être fermé en appelant PeerCollabCloseHandle.

Valeur retournée

Retourne S_OK si la fonction réussit. Sinon, la fonction retourne l’une des valeurs suivantes.

Code de retour	Description
E_OUTOFMEMORY	La mémoire est insuffisante pour prendre en charge cette opération.
E_INVALIDARG	L’un des arguments n’est pas valide.

Remarques

Cette API envoie une invitation au point de terminaison spécifié comme entrée. Cela ne garantit pas que le destinataire de l’invitation soit le contact spécifique auquel l’utilisateur a l’intention d’envoyer l’invitation. Pour vous assurer que l’invitation est envoyée au contact approprié, utilisez PeerCollabAsyncInviteContact.

Un toast s’affiche pour le destinataire de l’invitation. Ce toast sera converti en boîte de dialogue dans laquelle l’utilisateur peut accepter ou refuser l’invitation. Une fois l’invitation acceptée, l’application collaborative est lancée sur l’ordinateur du destinataire.

Pour recevoir correctement l’invitation, l’application doit être inscrite sur l’ordinateur du destinataire à l’aide de PeerCollabRegisterApplication. Il est également possible que l’expéditeur de l’invitation ait des codes d’échec retournés, car le destinataire a désactivé les invitations d’application.

La fonction PeerCollabGetInvitiationResponse retourne PEER_E_CONNECTION_FAILED si le point de terminaison auquel l’invitation est envoyée n’accepte pas d’invitations.

Si le destinataire accepte uniquement les invitations provenant de contacts approuvés, l’expéditeur de l’invitation doit être ajouté au magasin de contacts de l’ordinateur destinataire. L’expéditeur doit être ajouté au magasin de contacts avant la tentative d’invitation. Pour ajouter un contact au magasin de contacts, appelez PeerCollabAddContact.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Aucun pris en charge
Plateforme cible	Windows
En-tête	p2p.h
Bibliothèque	P2P.lib
DLL	P2P.dll