Função EnableRouter (iphlpapi.h)

Artigo
08/24/2023

A função EnableRouter ativa o encaminhamento IPv4 no computador local. EnableRouter também incrementa uma contagem de referência que acompanha o número de solicitações para habilitar o encaminhamento IPv4.

Sintaxe

IPHLPAPI_DLL_LINKAGE DWORD EnableRouter(
  HANDLE     *pHandle,
  OVERLAPPED *pOverlapped
);

Parâmetros

pHandle

Um ponteiro para um identificador. No momento, esse parâmetro não é usado.

pOverlapped

Um ponteiro para uma estrutura OVERLAPPED. Exceto para o membro hEvent , todos os membros dessa estrutura devem ser definidos como zero. O membro hEvent deve conter um identificador para um objeto de evento válido. Use a função CreateEvent para criar esse objeto de evento.

Valor retornado

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

Se a função falhar, use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Código de retorno	Descrição
ERROR_INVALID_PARAMETER	Um dos parâmetros é inválido. Esse erro será retornado se o parâmetro pOverlapped for NULL.
Outros	Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função EnableRouter é específica para o encaminhamento IPv4. Se o processo que chama EnableRouter terminar sem chamar UnenableRouter, o sistema diminuirá a contagem de referência que acompanha o número de solicitações para habilitar o encaminhamento IPv4 como se o processo tivesse chamado UnenableRouter.

Requisitos


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