Função UnenableRouter (iphlpapi.h)

Artigo
02/28/2024

A função UnenableRouter diminui a contagem de referência que acompanha o número de solicitações para habilitar o encaminhamento IPv4. Quando essa contagem de referência atinge zero, UnenableRouter desativa o encaminhamento IPv4 no computador local.

Sintaxe

IPHLPAPI_DLL_LINKAGE DWORD UnenableRouter(
                  OVERLAPPED *pOverlapped,
  [out, optional] LPDWORD    lpdwEnableCount
);

Parâmetros

pOverlapped

Um ponteiro para uma estrutura OVERLAPPED. Essa estrutura deve ser a mesma usada na chamada para a função EnableRouter .

[out, optional] lpdwEnableCount

Um ponteiro opcional para uma variável DWORD . Essa variável recebe o número de referências restantes.

Retornar valor

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

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

Comentários

A função UnenableRouter é específica para o encaminhamento IPv4. Cada chamada que um processo faz para UnenableRouter deve corresponder a uma chamada anterior para EnableRouter pelo mesmo processo. O sistema retorna um erro em chamadas desnecessárias para UnenableRouter. Como resultado, um determinado processo não é capaz de diminuir a contagem de referência que acompanha o número de solicitações para habilitar o encaminhamento IPv4 para outro processo. Além disso, se o encaminhamento IPv4 foi habilitado por um determinado processo, ele não pode ser desabilitado por um processo diferente.

Não é possível determinar com precisão a contagem de referência que acompanha o número de solicitações para habilitar o encaminhamento IPv4, pois pode haver outras solicitações EnableRouter pendentes. Portanto, o valor retornado para o parâmetro lpdwEnableCount é sempre uma contagem grande igual a ULONG_MAX/2.

Se o processo que chama EnableRouter terminar sem chamar UnenableRouter, o sistema diminuirá a contagem de referência que rastreia solicitações para habilitar o encaminhamento IPv4 como se o processo tivesse chamado UnenableRouter.

Depois de chamar o UnenableRouter, use a chamada CloseHandle para fechar o identificador do objeto de evento na estrutura OVERLAPPED .

Requisitos

Requisito	Valor
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