PeerCollabAsyncInviteContact, fonction (p2p.h)

Article
03/04/2024

La fonction PeerCollabAsyncInviteContact envoie une invitation à un contact d’homologue approuvé à rejoindre l’activité de collaboration d’homologue de l’expéditeur via une connexion sécurisée. La disponibilité de la réponse d’invitation est mise à jour via un événement asynchrone.

Syntaxe

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabAsyncInviteContact(
  [in, optional] PCPEER_CONTACT    pcContact,
  [in]           PCPEER_ENDPOINT   pcEndpoint,
  [in]           PCPEER_INVITATION pcInvitation,
  [in, optional] HANDLE            hEvent,
  [optional]     HANDLE            *phInvitation
);

Paramètres

[in, optional] pcContact

Pointeur vers une structure PEER_CONTACT qui contient les informations de contact associées au destinataire de l’invitation. Ce paramètre est facultatif.

Pour inviter le point de terminaison de l’homologue appelant spécifié dans pcEndpoint, définissez la valeur du pointeur sur NULL.

[in] pcEndpoint

Pointeur vers une structure PEER_ENDPOINT qui contient des informations sur le point de terminaison de l’homologue invité. Le point de terminaison doit être associé au contact d’homologue spécifié dans pcContact.

[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.

[optional] phInvitation

Pointeur vers un handle vers l’invitation envoyée. L’infrastructure nettoie les informations de réponse une fois la réponse d’invitation reçue si NULL est spécifié. Lorsque NULL n’est pas le handle spécifié pour l’invitation fournie, il 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.
E_NOTIMPL	pcEndpoint a la valeur NULL.
PEER_E_NOT_INITIALIZED	L’infrastructure d’homologue Windows n’est pas initialisée. L’appel de la fonction d’initialisation appropriée est obligatoire.

Remarques

Cette API garantit que l’homologue qui reçoit l’invitation est le contact spécifié comme entrée. La connexion échoue si le contact spécifique n’est pas présent sur le point de terminaison spécifié. L’utilisation de PeerCollabAsyncInviteContact est recommandée à la place du PeerCollabAsyncInviteEndpoint moins sécurisé.

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 contact 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.

Pour annuler une invitation en attente, appelez PeerCollabCancelInvitation.

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