Função MprAdminInterfaceEnum (mprapi.h)

Artigo
08/24/2023

A função MprAdminInterfaceEnum enumera todas as interfaces em um servidor especificado.

Sintaxe

DWORD MprAdminInterfaceEnum(
  [in]  MPR_SERVER_HANDLE hMprServer,
  [in]  DWORD             dwLevel,
  [out] LPBYTE            *lplpbBuffer,
  [in]  DWORD             dwPrefMaxLen,
  [out] LPDWORD           lpdwEntriesRead,
  [out] LPDWORD           lpdwTotalEntries,
  [in]  LPDWORD           lpdwResumeHandle
);

Parâmetros

[in] hMprServer

Manipule para o roteador no qual executar essa chamada. Obtenha esse identificador chamando MprAdminServerConnect.

[in] dwLevel

Um valor DWORD que descreve o formato no qual as informações são retornadas no parâmetro lplpbBuffer . Deve ser zero.

[out] lplpbBuffer

Após a conclusão bem-sucedida, um ponteiro para uma matriz de estruturas de MPR_INTERFACE_0 . Libere esse buffer de memória chamando MprAdminBufferFree.

[in] dwPrefMaxLen

Especifica o comprimento máximo preferencial dos dados retornados (em bytes de 8 bits). Se esse parâmetro for -1, o buffer retornado será grande o suficiente para conter todas as informações disponíveis.

[out] lpdwEntriesRead

Ponteiro para uma variável DWORD . Essa variável recebe o número total de interfaces que foram enumeradas da posição atual na enumeração.

[out] lpdwTotalEntries

Ponteiro para uma variável DWORD . Essa variável recebe o número total de interfaces que poderiam ter sido enumeradas da posição de currículo atual.

[in] lpdwResumeHandle

Ponteiro para uma variável DWORD . Essa variável especifica um identificador de currículo que pode ser usado para continuar a enumeração. O identificador deve ser zero na primeira chamada e deixado inalterado nas chamadas subsequentes. Se o código de retorno for ERROR_MORE_DATA, a chamada poderá ser emitida novamente usando o identificador para recuperar mais dados. Se no retorno, o identificador for NULL, a enumeração não poderá continuar. Para outros tipos de retorno de erro, esse identificador é inválido.

Esse parâmetro é opcional. Se o aplicativo de chamada especificar NULL para esse parâmetro, a função não retornará um identificador de retomada.

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_MORE_DATA	Mais informações estão disponíveis; a enumeração pode ser continuada.
ERROR_NOT_ENOUGH_MEMORY	Recursos insuficientes para concluir a operação.
ERROR_NOT_SUPPORTED	O valor de 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

Confira também

MPR_INTERFACE_0

MprAdminBufferFree

MprAdminServerConnect

Funções de administração do roteador

Referência de gerenciamento de roteador

Compartilhar via