Função MprAdminInterfaceGetInfo (mprapi.h)

Artigo
03/05/2024

A função MprAdminInterfaceGetInfo recupera informações de uma interface especificada em um servidor especificado.

Sintaxe

DWORD MprAdminInterfaceGetInfo(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] DWORD             dwLevel,
  [in] LPBYTE            *lplpbBuffer
);

Parâmetros

[in] hMprServer

Manipule para o roteador a ser consultado. Esse identificador é obtido de uma chamada anterior para MprAdminServerConnect.

[in] hInterface

Manipule para a interface obtida por uma chamada anterior para MprAdminInterfaceCreate.

[in] dwLevel

Um valor DWORD que descreve o formato no qual as informações são estruturadas no parâmetro lplpbBuffer . Os valores aceitáveis para dwLevel incluem 0, 1, 2 e 3, conforme listado na tabela a seguir.

Valor	Formato de estrutura
0	MPR_INTERFACE_0
1	MPR_INTERFACE_1
2	MPR_INTERFACE_2
3	Windows Server 2008 ou posterior: MPR_INTERFACE_3

Os valores de 1, 2 e 3 são válidos apenas para interfaces do tipo ROUTER_CONNECTION_STATE.

[in] lplpbBuffer

Um ponteiro para um MPR_INTERFACE_0, MPR_INTERFACE_1,
MPR_INTERFACE_2 ou estrutura MPR_INTERFACE_3 . O parâmetro dwLevel indica o tipo de estrutura. Libere essa memória chamando MprAdminBufferFree.

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.

Valor	Significado
ERROR_ACCESS_DENIED	O aplicativo de chamada não tem privilégios suficientes.
ERROR_INVALID_LEVEL	O dwLevel é 2, mas esse nível não tem suporte para a interface. Por exemplo, o tipo de interface, conforme definido na estrutura MPR_INTERFACE_X, não é IF_TYPE_FULL_ROUTER.
ERROR_INVALID_HANDLE	O valor hInterface é inválido.
ERROR_INVALID_PARAMETER	O parâmetro lplpbBuffer é NULL.
ERROR_NOT_ENOUGH_MEMORY	Recursos insuficientes para concluir a operação.
ERROR_NOT_SUPPORTED	O valor dwLevel é inválido.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Nenhum compatível
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	mprapi.h
Biblioteca	Mprapi.lib
DLL	Mprapi.dll