Función PeerCollabAsyncInviteEndpoint (p2p.h)

Artículo
03/15/2023

La función PeerCollabAsyncInviteEndpoint envía una invitación a un punto de conexión del mismo nivel especificado para unirse a la actividad de colaboración del mismo nivel del remitente. La disponibilidad de la respuesta a la invitación se actualiza a través de un evento asincrónico.

Sintaxis

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

Parámetros

[in] pcEndpoint

Puntero a una estructura de PEER_ENDPOINT que contiene información sobre el elemento del mismo nivel invitado. Este elemento del mismo nivel se envía una invitación cuando se llama a esta API.

Este parámetro no debe establecerse en NULL.

[in] pcInvitation

Puntero a una estructura de PEER_INVITATION que contiene la solicitud de invitación para enviar al punto de conexión especificado en pcEndpoint. E_INVALIDARG se devuelve si este parámetro está establecido en NULL.

[in, optional] hEvent

Controle el evento de esta invitación, creado por una llamada anterior a CreateEvent. El evento se señala cuando se actualiza el estado de la invitación asincrónica. Para obtener los datos de respuesta, llame a PeerCollabGetInvitationResponse.

Si no se proporciona el evento, el llamador debe sondear el resultado llamando a PeerCollabGetInvitationResponse.

[out, optional] phInvitation

Puntero a un identificador de la invitación enviada. Si este parámetro es NULL, el marco limpiará la información de respuesta una vez recibida la respuesta de invitación. Si este parámetro no es NULL, el identificador debe cerrarse llamando a PeerCollabCloseHandle.

Valor devuelto

Devuelve S_OK si la función se realiza correctamente. De lo contrario, la función devuelve uno de los valores siguientes.

Código devuelto	Descripción
E_OUTOFMEMORY	No hay suficiente memoria para admitir esta operación.
E_INVALIDARG	Uno de los argumentos no es válido.

Comentarios

Esta API envía una invitación al punto de conexión especificado como entrada. No garantiza que el destinatario de la invitación sea el contacto específico al que el usuario ha destinado a enviar la invitación. Para asegurarse de que la invitación se envía al contacto correcto, use PeerCollabAsyncInviteContact.

Aparecerá una notificación del sistema para el destinatario de la invitación. Esta notificación del sistema se convertirá en un cuadro de diálogo en el que el usuario puede aceptar o rechazar la invitación. Cuando la invitación se acepta correctamente, la aplicación colaborativa se inicia en el equipo del destinatario.

Para recibir correctamente la invitación, la aplicación debe registrarse en el equipo del destinatario mediante PeerCollabRegisterApplication. También es posible que el remitente de la invitación devuelva códigos de error porque el destinatario ha desactivado las invitaciones a la aplicación.

La función PeerCollabGetInvitiationResponse devolverá PEER_E_CONNECTION_FAILED si el punto de conexión al que se envía la invitación no acepta invitaciones.

Si el destinatario acepta invitaciones solo de contactos de confianza, el remitente de la invitación debe agregarse al almacén de contactos del equipo del destinatario. El remitente debe agregarse al almacén de contactos antes del intento de invitación. Para agregar un contacto al almacén de contactos, llame a PeerCollabAddContact.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	No se admite ninguno
Plataforma de destino	Windows
Encabezado	p2p.h
Library	P2P.lib
Archivo DLL	P2P.dll