Função SetTcpEntry (iphlpapi.h)

  • Artigo

A função SetTcpEntry define o estado de uma conexão TCP.

Sintaxe

IPHLPAPI_DLL_LINKAGE DWORD SetTcpEntry(
  [in] PMIB_TCPROW pTcpRow
);

Parâmetros

[in] pTcpRow

Um ponteiro para uma estrutura MIB_TCPROW . Essa estrutura especifica informações para identificar a conexão TCP a ser modificada. Ele também especifica o novo estado para a conexão TCP. O chamador deve especificar valores para todos os membros nessa estrutura.

Retornar valor

A função retornará NO_ERROR (zero) se a função for bem-sucedida.

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

Valor/código retornado Descrição
ERROR_ACCESS_DENIED
 Acesso negado. Esse erro é retornado no Windows Vista e no Windows Server 2008 em várias condições que incluem o seguinte: o usuário não tem os privilégios administrativos necessários no computador local ou o aplicativo não está em execução em um shell aprimorado como administrador interno (administrador RunAs).
ERROR_INVALID_PARAMETER
 Um parâmetro de entrada é inválido, nenhuma ação foi tomada. Esse erro será retornado se o parâmetro pTcpRow for NULL ou o membro Row na estrutura MIB_TCPROW apontada pelo parâmetro pTcpRow não estiver definido como MIB_TCP_STATE_DELETE_TCB.
ERROR_NOT_SUPPORTED
 O transporte IPv4 não está configurado no computador local.
317
 A função não pode definir a entrada TCP, pois o aplicativo está executando não elevado.
Outros
 Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

Atualmente, o único estado para o qual uma conexão TCP pode ser definida é MIB_TCP_STATE_DELETE_TCB.

No Windows Vista e posteriores, a função SetTcpEntry só pode ser chamada por um usuário conectado como membro do grupo Administradores. Se SetTcpEntry for chamado por um usuário que não seja membro do grupo Administradores, a chamada de função falhará e ERROR_ACCESS_DENIED será retornado.

A função SetTcpEntry também pode falhar devido ao UAC (controle de conta de usuário) no Windows Vista e posterior. Se um aplicativo que contém essa função for executado por um usuário conectado como um membro do grupo Administradores diferente do Administrador interno, essa chamada falhará, a menos que o aplicativo tenha sido marcado no arquivo de manifesto com um requestedExecutionLevel definido como requireAdministrator. Se o aplicativo não tiver esse arquivo de manifesto, um usuário conectado como membro do grupo Administradores diferente do Administrador interno deverá executar o aplicativo em um shell aprimorado como administrador interno (administrador RunAs) para que essa função tenha êxito.

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

Confira também

Referência de função auxiliar de IP

Página Inicial do Auxiliar de IP

MIB_TCPROW