Função PeerCollabAsyncInviteEndpoint (p2p.h)

Artigo
03/05/2024

A função PeerCollabAsyncInviteEndpoint envia um convite para um ponto de extremidade par especificado para ingressar na atividade de colaboração de pares do remetente. A disponibilidade da resposta ao convite é atualizada por meio de um evento assíncrono.

Sintaxe

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

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. E_INVALIDARG será retornado se esse parâmetro for definido como NULL.

[in, optional] hEvent

Manipule para o evento para este convite, criado por uma chamada anterior para CreateEvent. O evento é sinalizado quando o status do convite assíncrono é atualizado. Para obter os dados de resposta, chame PeerCollabGetInvitationResponse.

Se o evento não for fornecido, o chamador deverá sondar o resultado chamando PeerCollabGetInvitationResponse.

[out, optional] phInvitation

Um ponteiro para um identificador para o convite enviado. Se esse parâmetro for NULL, a estrutura limpará as informações de resposta depois que a resposta do convite for recebida. Se esse parâmetro não for NULL, o identificador deverá ser fechado chamando PeerCollabCloseHandle.

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.

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, use PeerCollabAsyncInviteContact.

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.

A função PeerCollabGetInvitiationResponse retornará PEER_E_CONNECTION_FAILED se o ponto de extremidade ao qual o convite está sendo enviado não estiver aceitando convites.

Se o destinatário estiver aceitando convites somente de contatos confiáveis, o remetente do convite deverá ser adicionado ao repositório de contatos do computador destinatário. O remetente deve ser adicionado ao repositório de contatos antes da tentativa de convite. Para adicionar um contato ao repositório de contatos, chame PeerCollabAddContact.

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