Freigeben über


PeerCollabInviteEndpoint-Funktion (p2p.h)

Die PeerCollabInviteEndpoint-Funktion sendet eine Einladung an einen angegebenen Peerendpunkt, um der Peerzusammenarbeitsaktivität des Absenders beizutreten. Dieser Aufruf ist synchron und ruft bei erfolgreicher Ausführung eine Antwort vom Peerendpunkt ab.

Syntax

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

Parameter

[in] pcEndpoint

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

Dieser Parameter darf nicht auf NULL festgelegt werden.

[in] pcInvitation

Zeiger auf eine PEER_INVITATION Struktur, die die Einladungsanforderung zum Senden an den in pcEndpoint angegebenen Endpunkt enthält. 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 bei der Ausgabe NULL.

Geben Sie den dieser Struktur zugeordneten Arbeitsspeicher frei, indem Sie ihn an PeerFreeData übergeben.

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 innerhalb von 5 Minuten nicht geantwortet.

Hinweise

Diese API sendet eine Einladung an den als Eingabe angegebenen Endpunkt. Es wird nicht garantiert, dass der Empfänger der Einladung der spezifische Kontakt ist, an den der Benutzer die Einladung senden wollte. Um sicherzustellen, dass die Einladung an den richtigen Kontakt gesendet wird, rufen Sie PeerCollabInviteContact auf.

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 mit PeerCollabRegisterApplication registriert werden. Es ist auch möglich, dass der Absender der Einladung Fehlercodes zurückgegeben hat, da der Empfänger Anwendungseinladungen deaktiviert hat.

Der Empfänger der Einladung muss innerhalb von 5 Minuten antworten, um ein 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_ENDPOINT

PEER_INVITATION

PEER_INVITATION_RESPONSE

Peerzusammenarbeits-API-Funktionen

PeerCollabGetAppLaunchInfo