Partager via


PeerCollabInviteContact, fonction (p2p.h)

La fonction PeerCollabInviteContact envoie une invitation à rejoindre une activité de collaboration d’homologue à un contact approuvé. Cet appel est synchrone et, s’il réussit, obtient une réponse du contact.

Syntaxe

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

Paramètres

[in] pcContact

Pointeur vers une structure de PEER_CONTACT qui contient les informations de contact associées à l’invité.

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

[in] pcInvitation

Pointeur vers une structure de PEER_INVITATION qui contient la demande d’invitation à envoyer aux points de terminaison spécifiés dans pcEndpoint. Ce paramètre ne doit pas être défini sur NULL.

[out] ppResponse

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

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

Libérez la mémoire retournée en appelant 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 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 PeerCollabInviteContact est recommandée à la place du PeerCollabInviteEndpoint 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.

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.

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_CONTACT

PEER_ENDPOINT

PEER_INVITATION

PEER_INVITATION_RESPONSE

PeerCollabGetAppLaunchInfo