Freigeben über


PeerCollabInviteContact-Funktion (p2p.h)

Die PeerCollabInviteContact-Funktion sendet eine Einladung zur Teilnahme an einer Peerzusammenarbeitsaktivität an einen vertrauenswürdigen Kontakt. Dieser Aufruf ist synchron und erhält bei erfolgreicher Ausführung eine Antwort vom Kontakt.

Syntax

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

Parameter

[in] pcContact

Zeiger auf eine PEER_CONTACT-Struktur , die die Kontaktinformationen enthält, die dem eingeladenen Benutzer zugeordnet sind.

[in] pcEndpoint

Zeiger auf eine PEER_ENDPOINT Struktur, die Informationen zum eingeladenen Peer enthält. Dieser Peer wird eine Einladung gesendet, wenn diese API aufgerufen wird.

[in] pcInvitation

Zeiger auf eine PEER_INVITATION-Struktur , die die Einladungsanforderung enthält, die an die in pcEndpoint angegebenen Endpunkte gesendet werden soll. Dieser Parameter darf nicht auf NULL festgelegt werden.

[out] ppResponse

Zeiger auf eine PEER_INVITATION_RESPONSE Struktur, die die Antworten eines eingeladenen Peerendpunkts auf die Einladungsanforderung empfängt.

Wenn dieser Aufruf mit einem Fehler fehlschlägt, ist dieser Parameter NULL.

Geben Sie den zurückgegebenen Arbeitsspeicher frei, indem Sie PeerFreeData aufrufen.

Rückgabewert

Gibt S_OK zurück, wenn die Funktion erfolgreich ist. Andernfalls gibt die Funktion einen der folgenden Werte zurück.

Rückgabecode Beschreibung
E_OUTOFMEMORY
Es ist nicht genügend Arbeitsspeicher vorhanden, um diesen Vorgang zu unterstützen.
E_INVALIDARG
Eines der Argumente ist ungültig.
PEER_E_TIMEOUT
Der Empfänger der Einladung hat nicht innerhalb von 5 Minuten geantwortet.

Hinweise

Diese API stellt sicher, dass der Peer, der die Einladung empfängt, der als Eingabe angegebene Kontakt ist. Die Verbindung schlägt fehl, wenn der bestimmte Kontakt auf dem angegebenen Endpunkt nicht vorhanden ist. Die Verwendung von PeerCollabInviteContact wird anstelle des weniger sicheren PeerCollabInviteEndpoint empfohlen.

Für den Empfänger der Einladung wird ein Popup angezeigt. Dieses Popup wird in ein Dialogfeld konvertiert, in dem der Benutzer die Einladung annehmen oder ablehnen kann. Wenn die Einladung erfolgreich angenommen wurde, wird die Zusammenarbeitsanwendung auf dem Computer des Empfängers gestartet.

Damit die Einladung erfolgreich empfangen werden kann, muss die Anwendung auf dem Computer des Empfängers mithilfe von PeerCollabRegisterApplication registriert werden. Es ist auch möglich, dass der Absender der Einladung Fehlercodes zurückgibt, da der Empfänger Anwendungseinladungen deaktiviert hat.

Wenn der Empfänger nur Einladungen von vertrauenswürdigen Kontakten akzeptiert, muss der Absender der Einladung dem Kontaktspeicher des Empfängercomputers hinzugefügt werden. Der Absender muss dem Kontaktspeicher vor dem Einladungsversuch hinzugefügt werden. Um einen Kontakt zum Kontaktspeicher hinzuzufügen, rufen Sie PeerCollabAddContact auf.

Der Empfänger der Einladung muss innerhalb von 5 Minuten antworten, um timeout zu vermeiden.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Nicht unterstützt
Zielplattform Windows
Kopfzeile p2p.h
Bibliothek P2P.lib
DLL P2P.dll

Weitere Informationen

PEER_CONTACT

PEER_ENDPOINT

PEER_INVITATION

PEER_INVITATION_RESPONSE

PeerCollabGetAppLaunchInfo