Función PeerCollabInviteEndpoint (p2p.h)

La función PeerCollabInviteEndpoint 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. Esta llamada es sincrónica y, si se ejecuta correctamente, obtiene una respuesta del punto de conexión del mismo nivel.

Sintaxis

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabInviteEndpoint(
  [in]  PCPEER_ENDPOINT           pcEndpoint,
  [in]  PCPEER_INVITATION         pcInvitation,
  [out] PPEER_INVITATION_RESPONSE *ppResponse
);

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. Este parámetro no debe establecerse en NULL.

[out] ppResponse

Puntero a una estructura de PEER_INVITATION_RESPONSE que recibe las respuestas de un punto de conexión del mismo nivel invitado a la solicitud de invitación.

Si se produce un error en esta llamada, en la salida, este parámetro será NULL.

Libere la memoria asociada a esta estructura pasándola a PeerFreeData.

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.
PEER_E_TIMEOUT	El destinatario de la invitación no ha respondido en un plazo de 5 minutos.

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 pretende enviar la invitación. Para asegurarse de que la invitación se envía al contacto correcto, llame a PeerCollabInviteContact.

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, se inicia la aplicación colaborativa 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.

El destinatario de la invitación debe responder en un plazo de 5 minutos para evitar el tiempo de espera.

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

Consulte también

PEER_ENDPOINT

PEER_INVITATION

PEER_INVITATION_RESPONSE

Funciones de API de colaboración del mismo nivel

PeerCollabGetAppLaunchInfo