Função LookupPersistentUdpPortReservation (iphlpapi.h)

Artigo
08/24/2023

A função LookupPersistentUdpPortReservation procura o token para uma reserva de porta UDP persistente para um bloco consecutivo de portas TCP no computador local.

Sintaxe

IPHLPAPI_DLL_LINKAGE ULONG LookupPersistentUdpPortReservation(
  [in]  USHORT   StartPort,
  [in]  USHORT   NumberOfPorts,
  [out] PULONG64 Token
);

Parâmetros

[in] StartPort

O número da porta UDP inicial na ordem de bytes de rede.

[in] NumberOfPorts

O número de números de porta UDP que foram reservados.

[out] Token

Um ponteiro para um token de reserva de porta retornado se a função for bem-sucedida.

Retornar valor

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro.

Código de retorno	Descrição
ERROR_INVALID_PARAMETER	Um parâmetro inválido foi passado para a função. Esse erro será retornado se zero for passado nos parâmetros StartPort ou NumberOfPorts .
ERROR_NOT_FOUND	O elemento não foi encontrado. Esse erro será retornado se o bloco de porta persistente especificado pelos parâmetros StartPort e NumberOfPorts não puder ser encontrado.
Outros	Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função LookupPersistentUdpPortReservation é definida no Windows Vista e posterior.

A função LookupPersistentUdpPortReservation é usada para pesquisar o token para uma reserva persistente para um bloco de portas UDP.

Uma reserva persistente para um bloco de portas UDP é criada por uma chamada para a função CreatePersistentUdpPortReservation . Os parâmetros StartPort ou NumberOfPorts passados para a função LookupPersistentUdpPortReservation devem corresponder aos valores usados quando a reserva persistente para um bloco de portas TCP foi criada pela função CreatePersistentUdpPortReservation .

Se a função LookupPersistentUdpPortReservation for bem-sucedida, o parâmetro Token retornado apontará para o token para a reserva de porta persistente para o bloco de portas UDP. Observe que o token de uma determinada reserva persistente para um bloco de portas TCP pode ser alterado sempre que o sistema é reiniciado.

Um aplicativo pode solicitar atribuições de porta da reserva de porta UDP abrindo um soquete UDP e chamando a função WSAIoctl especificando o SIO_ASSOCIATE_PORT_RESERVATION IOCTL e passando o token de reserva antes de emitir uma chamada para a função de associação no soquete.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	iphlpapi.h
Biblioteca	Iphlpapi.lib
DLL	Iphlpapi.dll