PeerCollabAsyncInviteEndpoint-Funktion (p2p.h)

Artikel
08/25/2023

Die PeerCollabAsyncInviteEndpoint-Funktion sendet eine Einladung an einen angegebenen Peerendpunkt, um der Peerzusammenarbeitsaktivität des Absenders beizutreten. Die Verfügbarkeit der Antwort auf die Einladung wird durch ein asynchrones Ereignis aktualisiert.

Syntax

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabAsyncInviteEndpoint(
  [in]            PCPEER_ENDPOINT   pcEndpoint,
  [in]            PCPEER_INVITATION pcInvitation,
  [in, optional]  HANDLE            hEvent,
  [out, optional] HANDLE            *phInvitation
);

Parameter

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

Dieser Parameter darf nicht auf NULL festgelegt werden.

[in] pcInvitation

Zeiger auf eine PEER_INVITATION-Struktur , die die Einladungsanforderung enthält, die an den in pcEndpoint angegebenen Endpunkt gesendet werden soll. E_INVALIDARG wird zurückgegeben, wenn dieser Parameter auf NULL festgelegt ist.

[in, optional] hEvent

Behandeln Sie das Ereignis für diese Einladung, das durch einen vorherigen Aufruf von CreateEvent erstellt wurde. Das Ereignis wird signalisiert, wenn die status der asynchronen Einladung aktualisiert wird. Um die Antwortdaten abzurufen, rufen Sie PeerCollabGetInvitationResponse auf.

Wenn das Ereignis nicht angegeben wird, muss der Aufrufer das Ergebnis abfragen, indem er PeerCollabGetInvitationResponse aufruft.

[out, optional] phInvitation

Ein Zeiger auf ein Handle auf die gesendete Einladung. Wenn dieser Parameter NULL ist, bereinigt das Framework die Antwortinformationen, nachdem die Einladungsantwort empfangen wurde. Wenn dieser Parameter nicht NULL ist, muss das Handle geschlossen werden, indem PeerCollabCloseHandle aufgerufen wird.

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.

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. Verwenden Sie PeerCollabAsyncInviteContact, um sicherzustellen, dass die Einladung an den richtigen Kontakt gesendet wird.

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.

Die Funktion PeerCollabGetInvitiationResponse gibt PEER_E_CONNECTION_FAILED zurück, wenn der Endpunkt, an den die Einladung gesendet wird, keine Einladungen akzeptiert.

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.

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