Partager via


PeerCollabInviteEndpoint, fonction (p2p.h)

La fonction PeerCollabInviteEndpoint envoie une invitation à un point de terminaison homologue spécifié pour rejoindre l’activité de collaboration d’homologue de l’expéditeur. Cet appel est synchrone et, en cas de réussite, obtient une réponse du point de terminaison de l’homologue.

Syntaxe

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabInviteEndpoint(
  [in]  PCPEER_ENDPOINT           pcEndpoint,
  [in]  PCPEER_INVITATION         pcInvitation,
  [out] PPEER_INVITATION_RESPONSE *ppResponse
);

Paramètres

[in] pcEndpoint

Pointeur vers une structure PEER_ENDPOINT qui contient des informations sur l’homologue invité. Une invitation est envoyée à cet homologue 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. Ce paramètre ne doit pas être défini sur NULL.

[out] ppResponse

Pointeur vers une structure PEER_INVITATION_RESPONSE qui reçoit les réponses d’un point de terminaison homologue invité à la demande d’invitation.

Si cet appel échoue avec une erreur, à la sortie, ce paramètre est NULL.

Libérez la mémoire associée à cette structure en la transmettant à PeerFreeData.

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.
PEER_E_TIMEOUT
Le destinataire de l’invitation n’a pas répondu dans les 5 minutes.

Remarques

Cette API envoie une invitation au point de terminaison spécifié en tant qu’entrée. Cela ne garantit pas que le destinataire de l’invitation est 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é, appelez PeerCollabInviteContact.

Un toast s’affiche pour le destinataire de l’invitation. Ce toast est 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.

Le destinataire de l’invitation doit répondre dans les 5 minutes pour éviter le délai d’expiration.

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

Voir aussi

PEER_ENDPOINT

PEER_INVITATION

PEER_INVITATION_RESPONSE

Fonctions de l’API De collaboration entre pairs

PeerCollabGetAppLaunchInfo