PeerCollabAsyncInviteContact-Funktion (p2p.h)

Artikel
08/25/2023

Die PeerCollabAsyncInviteContact-Funktion sendet eine Einladung an einen vertrauenswürdigen Peerkontakt, um der Peerzusammenarbeitsaktivität des Absenders über eine gesicherte Verbindung beizutreten. Die Verfügbarkeit der Einladungsantwort wird durch ein asynchrones Ereignis aktualisiert.

Syntax

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabAsyncInviteContact(
  [in, optional] PCPEER_CONTACT    pcContact,
  [in]           PCPEER_ENDPOINT   pcEndpoint,
  [in]           PCPEER_INVITATION pcInvitation,
  [in, optional] HANDLE            hEvent,
  [optional]     HANDLE            *phInvitation
);

Parameter

[in, optional] pcContact

Zeiger auf eine PEER_CONTACT-Struktur , die die Kontaktinformationen enthält, die dem Empfänger der Einladung zugeordnet sind. Dieser Parameter ist optional.

Um den Endpunkt des aufrufenden Peers einzuladen, der in pcEndpoint angegeben ist, legen Sie den Zeigerwert auf NULL fest.

[in] pcEndpoint

Zeiger auf eine PEER_ENDPOINT Struktur, die Informationen zum Endpunkt des eingeladenen Peers enthält. Der Endpunkt muss dem in pcContact angegebenen Peerkontakt zugeordnet sein.

[in] pcInvitation

Zeiger auf eine PEER_INVITATION Struktur, die die Einladungsanforderung zum Senden an den in pcEndpoint angegebenen Endpunkt enthält. 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. Rufen Sie PeerCollabGetInvitationResponse auf, um die Antwortdaten abzurufen.

Wenn das Ereignis nicht bereitgestellt wird, muss der Aufrufer das Ergebnis abrufen, indem er PeerCollabGetInvitationResponse aufruft.

[optional] phInvitation

Ein Zeiger auf ein Handle auf die gesendete Einladung. Das Framework bereinigt die Antwortinformationen, nachdem die Einladungsantwort empfangen wurde, wenn NULL angegeben ist. Wenn NULL nicht das angegebene Handle für die einladung ist, muss es durch Aufrufen von PeerCollabCloseHandle geschlossen werden.

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.
E_NOTIMPL	pcEndpoint ist NULL.
PEER_E_NOT_INITIALIZED	Die Windows-Peerinfrastruktur wird nicht initialisiert. Der Aufruf der relevanten Initialisierungsfunktion ist erforderlich.

Hinweise

Diese API stellt sicher, dass der Peer, der die Einladung empfängt, der kontakt ist, der als Eingabe angegeben ist. Die Verbindung schlägt fehl, wenn der spezifische Kontakt auf dem angegebenen Endpunkt nicht vorhanden ist. Die Verwendung von PeerCollabAsyncInviteContact wird anstelle des weniger sicheren PeerCollabAsyncInviteEndpoint 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.

Um die Einladung erfolgreich zu erhalten, 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.

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

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

Um eine ausstehende Einladung abzubrechen, rufen Sie PeerCollabCancelInvitation 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