Función PeerCollabAsyncInviteContact (p2p.h)

Artículo
03/15/2023

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

Sintaxis

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
);

Parámetros

[in, optional] pcContact

Puntero a una estructura de PEER_CONTACT que contiene la información de contacto asociada al destinatario de la invitación. Este parámetro es opcional.

Para invitar al punto de conexión del mismo nivel de llamada especificado en pcEndpoint, establezca el valor del puntero en NULL.

[in] pcEndpoint

Puntero a una estructura de PEER_ENDPOINT que contiene información sobre el punto de conexión del mismo nivel invitado. El punto de conexión debe estar asociado al contacto del mismo nivel especificado en pcContact.

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

[optional] phInvitation

Puntero a un identificador de la invitación enviada. El marco limpiará la información de respuesta después de que se reciba la respuesta de invitación si se especifica NULL . Cuando NULL no es el identificador especificado para la invitación proporcionada, 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.
E_NOTIMPL	pcEndpoint es NULL.
PEER_E_NOT_INITIALIZED	La infraestructura del mismo nivel de Windows no se inicializa. Se requiere llamar a la función de inicialización pertinente.

Comentarios

Esta API garantiza que el elemento del mismo nivel que recibe la invitación sea el contacto especificado como entrada. Se producirá un error en la conexión si el contacto específico no está presente en el punto de conexión especificado. Se recomienda el uso de PeerCollabAsyncInviteContact en lugar de PeerCollabAsyncInviteEndpoint menos seguro.

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 estar registrada 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 contacto 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.

Para cancelar una invitación pendiente, llame a PeerCollabCancelInvitation.

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