Funzione PeerCollabAsyncInviteEndpoint (p2p.h)

Articolo
03/15/2023

La funzione PeerCollabAsyncInviteEndpoint invia un invito a un endpoint peer specificato per aggiungere l'attività di collaborazione peer del mittente. La disponibilità della risposta all'invito viene aggiornata tramite un evento asincrono.

Sintassi

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

Parametri

[in] pcEndpoint

Puntatore a una struttura PEER_ENDPOINT che contiene informazioni sul peer invitato. Questo peer viene inviato un invito quando questa API viene chiamata.

Questo parametro non deve essere impostato su NULL.

[in] pcInvitation

Puntatore a una struttura PEER_INVITATION che contiene la richiesta di invito a inviare all'endpoint specificato in pcEndpoint. E_INVALIDARG viene restituito se questo parametro è impostato su NULL.

[in, optional] hEvent

Gestire l'evento per questo invito, creato da una chiamata precedente a CreateEvent. L'evento viene segnalato quando viene aggiornato lo stato dell'invito asincrono. Per ottenere i dati della risposta, chiamare PeerCollabGetInvitationResponse.

Se l'evento non viene specificato, il chiamante deve eseguire il polling per il risultato chiamando PeerCollabGetInvitationResponse.

[out, optional] phInvitation

Puntatore a un handle per l'invito inviato. Se questo parametro è NULL, il framework pulisce le informazioni sulla risposta dopo la ricezione della risposta all'invito. Se questo parametro non è NULL, l'handle deve essere chiuso chiamando PeerCollabCloseHandle.

Valore restituito

Restituisce S_OK se la funzione ha esito positivo. In caso contrario, la funzione restituisce uno dei valori seguenti.

Codice restituito	Descrizione
E_OUTOFMEMORY	Memoria insufficiente per supportare questa operazione.
E_INVALIDARG	Uno degli argomenti non è valido.

Commenti

Questa API invia un invito all'endpoint specificato come input. Non garantisce che il destinatario dell'invito sia il contatto specifico a cui l'utente intende inviare l'invito. Per assicurarsi che l'invito venga inviato al contatto corretto usare PeerCollabAsyncInviteContact.

Verrà visualizzato un avviso popup per il destinatario dell'invito. Questo avviso popup verrà convertito in una finestra di dialogo in cui l'utente può accettare o rifiutare l'invito. Quando l'invito viene accettato correttamente, l'applicazione collaborativa viene avviata nel computer del destinatario.

Per ricevere correttamente l'invito, l'applicazione deve essere registrata nel computer del destinatario usando PeerCollabRegisterApplication. È anche possibile che il mittente dell'invito abbia codici di errore restituiti perché il destinatario ha disattivato gli inviti dell'applicazione.

La funzione PeerCollabGetInvitiationResponse restituirà PEER_E_CONNECTION_FAILED se l'endpoint a cui viene inviato l'invito non accetta gli inviti.

Se il destinatario accetta inviti solo da contatti attendibili, il mittente dell'invito deve essere aggiunto all'archivio contatti del computer destinatario. Il mittente deve essere aggiunto all'archivio contatti prima del tentativo di invito. Per aggiungere un contatto all'archivio contatti, chiamare PeerCollabAddContact.

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista [solo app desktop]
Server minimo supportato	Nessuno supportato
Piattaforma di destinazione	Windows
Intestazione	p2p.h
Libreria	P2P.lib
DLL	P2P.dll