Função SetIfEntry (iphlpapi.h)
A função SetIfEntry define o status administrativo de uma interface.
Sintaxe
IPHLPAPI_DLL_LINKAGE DWORD SetIfEntry(
[in] PMIB_IFROW pIfRow
);
Parâmetros
[in] pIfRow
Um ponteiro para uma estrutura MIB_IFROW . O membro dwIndex dessa estrutura especifica a interface na qual definir status administrativas. O membro dwAdminStatus especifica o novo status administrativo. O membro dwAdminStatus pode ser um dos valores a seguir.
| Valor | Significado |
|---|---|
|
A interface está habilitada administrativamente. |
|
A interface está desabilitada administrativamente. |
Valor retornado
Se a função for bem-sucedida, o valor retornado será NO_ERROR.
Se a função falhar, o valor retornado será um dos códigos de erro a seguir.
| Código de retorno | Descrição |
|---|---|
|
O acesso foi negado. Esse erro é retornado no Windows Vista e, posteriormente, 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). |
|
O sistema não pode encontrar o arquivo especificado. Esse erro será retornado no Windows Vista e, posteriormente, se o adaptador de rede especificado pelo membro dwIndex da estrutura MIB_IFROW apontada pelo parâmetro pIfRow não puder ser encontrado. |
|
Um parâmetro inválido foi passado para a função. Esse erro será retornado se um ponteiro NULL for passado no parâmetro pIfRow ou o membro dwIndex do MIB_IFROW apontado pelo parâmetro pIfRow não tiver sido especificado. Esse erro também será retornado no Windows Server 2003 e anterior se o adaptador de rede especificado pelo membro dwIndex da estrutura MIB_IFROW apontada pelo parâmetro pIfRow não puder ser encontrado. |
|
A solicitação não terá suporte. Esse erro será retornado no Windows Server 2003 e anterior se nenhuma pilha TCP/IP estiver configurada no computador local. |
|
Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado. |
Comentários
A função SetIfEntry é usada para definir o status administrativo de uma interface em um computador local.
O membro dwIndex na estrutura MIB_IFROW apontada pelo parâmetro pIfRow deve ser inicializado para o índice de interface.
A função SetIfEntry falhará se o membro dwIndex do MIB_IFROW apontado pelo parâmetro pIfRow não corresponder a uma interface existente no computador local.
No Windows Vista e posteriores, a função SetIfEntry só pode ser chamada por um usuário conectado como membro do grupo Administradores. Se SetIfEntry 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 SetIfEntry 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
| 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
GetIfTable
Referência de função auxiliar de IP