Compartilhar via


Função PeerCollabInviteEndpoint (p2p.h)

A função PeerCollabInviteEndpoint envia um convite para um ponto de extremidade par especificado para ingressar na atividade de colaboração de pares do remetente. Essa chamada é síncrona e, se bem-sucedida, obtém uma resposta do ponto de extremidade par.

Sintaxe

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

Parâmetros

[in] pcEndpoint

Ponteiro para uma estrutura PEER_ENDPOINT que contém informações sobre o par convidado. Esse par recebe um convite quando essa API é chamada.

Esse parâmetro não deve ser definido como NULL.

[in] pcInvitation

Ponteiro para uma estrutura PEER_INVITATION que contém a solicitação de convite para enviar para o ponto de extremidade especificado em pcEndpoint. Esse parâmetro não deve ser definido como NULL.

[out] ppResponse

Ponteiro para uma estrutura PEER_INVITATION_RESPONSE que recebe as respostas de um ponto de extremidade par convidado para a solicitação de convite.

Se essa chamada falhar com um erro, na saída esse parâmetro será NULL.

Libere a memória associada a essa estrutura passando-a para PeerFreeData.

Retornar valor

Retorna S_OK se a função for bem-sucedida. Caso contrário, a função retornará um dos valores a seguir.

Código de retorno Descrição
E_OUTOFMEMORY
Não há memória suficiente para dar suporte a essa operação.
E_INVALIDARG
Um dos argumentos é inválido.
PEER_E_TIMEOUT
O destinatário do convite não respondeu dentro de 5 minutos.

Comentários

Essa API envia um convite para o ponto de extremidade especificado como entrada. Ele não garante que o destinatário do convite seja o contato específico para o qual o usuário pretendia enviar o convite. Para garantir que o convite seja enviado para o contato correto, chame PeerCollabInviteContact.

Uma notificação do sistema será exibida para o destinatário do convite. Essa notificação do sistema será convertida em uma caixa de diálogo na qual o usuário pode aceitar ou recusar o convite. Quando o convite é aceito com êxito, o aplicativo colaborativo é iniciado no computador do destinatário.

Para receber o convite com êxito, o aplicativo deve ser registrado no computador do destinatário usando PeerCollabRegisterApplication. Também é possível que o remetente do convite tenha códigos de falha retornados porque o destinatário desativou os convites do aplicativo.

O destinatário do convite deve responder dentro de 5 minutos para evitar o tempo limite.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Nenhum compatível
Plataforma de Destino Windows
Cabeçalho p2p.h
Biblioteca P2P.lib
DLL P2P.dll

Confira também

PEER_ENDPOINT

PEER_INVITATION

PEER_INVITATION_RESPONSE

Funções da API de Colaboração de Pares

PeerCollabGetAppLaunchInfo