Função MprConfigInterfaceGetInfo (mprapi.h)

Artigo
08/24/2023

A função MprConfigInterfaceGetInfo recupera a configuração da interface especificada do roteador.

Sintaxe

DWORD MprConfigInterfaceGetInfo(
  [in]      HANDLE  hMprConfig,
  [in]      HANDLE  hRouterInterface,
  [in]      DWORD   dwLevel,
  [in, out] LPBYTE  *lplpBuffer,
  [out]     LPDWORD lpdwBufferSize
);

Parâmetros

[in] hMprConfig

Manipule para a configuração do roteador. Obtenha esse identificador chamando MprConfigServerConnect.

[in] hRouterInterface

Manipule para a configuração de interface para a qual recuperar informações. Obtenha esse identificador chamando MprConfigInterfaceCreate, MprConfigInterfaceGetHandle ou MprConfigInterfaceEnum.

[in] dwLevel

Um valor DWORD que descreve o formato no qual as informações são retornadas no parâmetro lplpBuffer . 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

[in, out] lplpBuffer

Na entrada, um ponteiro não NULL .

Após a conclusão bem-sucedida, um ponteiro para uma matriz de MPR_INTERFACE_0, MPR_INTERFACE_1,
MPR_INTERFACE_2 ou estrutura MPR_INTERFACE_3 . O parâmetro dwLevel indica o tipo de estrutura. Libere esse buffer chamando MprConfigBufferFree.

[out] lpdwBufferSize

Ponteiro para uma variável DWORD . Essa variável recebe o tamanho, em bytes, dos dados retornados por meio de lplpBuffer.

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 seguintes códigos de erro.

Valor	Significado
ERROR_INVALID_PARAMETER	Pelo menos um dos seguintes é verdadeiro: hMprConfig é NULL hRouterInterface é NULL dwLevel não é 0, 1, 2 ou 3. lplpBuffer é NULL lpdwBufferSize é NULL
ERROR_NOT_ENOUGH_MEMORY	Recursos insuficientes para concluir a operação.
ERROR_NO_SUCH_INTERFACE	A interface que corresponde a hRouterInterface não está presente na configuração do roteador.

Requisitos


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