Função MprAdminPortEnum (mprapi.h)

Artigo
03/05/2024

A função MprAdminPortEnum enumera todas as portas ativas em uma conexão específica ou todas as portas disponíveis para uso ou usadas atualmente pelo RAS.

Sintaxe

DWORD MprAdminPortEnum(
  [in]  RAS_SERVER_HANDLE hRasServer,
  [in]  DWORD             dwLevel,
  [in]  HANDLE            hRasConnection,
  [out] LPBYTE            *lplpbBuffer,
  [in]  DWORD             dwPrefMaxLen,
  [out] LPDWORD           lpdwEntriesRead,
  [out] LPDWORD           lpdwTotalEntries,
  [in]  LPDWORD           lpdwResumeHandle
);

Parâmetros

[in] hRasServer

Um identificador para o servidor RAS cujas portas devem ser enumeradas. Para obter esse identificador, chame 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.

[in] hRasConnection

Um identificador para uma conexão para a qual as portas ativas são enumeradas. Se esse parâmetro for INVALID_HANDLE_VALUE, todas as portas em uso ou disponíveis para uso pelo RRAS serão enumeradas. Para obter esse identificador, chame MprAdminConnectionEnum.

[out] lplpbBuffer

Após a conclusão bem-sucedida, um ponteiro para uma matriz de estruturas RAS_PORT_0 que descreve a porta. Libere essa memória chamando MprAdminBufferFree.

[in] dwPrefMaxLen

Um valor que 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 manter todos os dados disponíveis.

[out] lpdwEntriesRead

Um ponteiro para uma variável DWORD . Essa variável recebe o número total de portas que são enumeradas da posição de currículo atual.

[out] lpdwTotalEntries

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

[in] lpdwResumeHandle

Um ponteiro para uma variável DWORD . Na execução bem-sucedida, esse parâmetro especifica um identificador que pode ser usado para retomar a enumeração. Esse parâmetro 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 relançada com o identificador para recuperar mais dados. Se o identificador for NULL no retorno, a enumeração não poderá continuar. Esse identificador é inválido para outros tipos de retorno de erro.

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 códigos de erro listados na tabela a seguir.

Valor	Significado
ERROR_ACCESS_DENIED	O aplicativo de chamada não tem privilégios suficientes.
ERROR_DDM_NOT_RUNNING	O DDM (Gerenciador de Discagem de Demanda) não está em execução, possivelmente porque o DIM (Gerenciador de Interface Dinâmica) está configurado para ser executado somente em uma LAN.
ERROR_INVALID_PARAMETER	Pelo menos um dos seguintes parâmetros é NULL ou não aponta para memória válida: lplpBuffer, lpdwEntriesRead ou lpdwTotalEntries.
ERROR_MORE_DATA	Nem todos os dados foram retornados com essa chamada. Para obter dados adicionais, chame a função novamente usando o identificador que foi retornado no parâmetro IpdwResumeHandle .
ERROR_NOT_SUPPORTED	O parâmetro dwLevel não é zero.
ERROR_INVALID_HANDLE	O parâmetro hConnection é NULL.
Outros	Um erro de MprError.h, RasError.h ou WinError.h.

Comentários

Se o redistribuível RRAS estiver instalado, essa função estará disponível no Windows NT 4.0. No entanto, a versão de Mprapi.dll fornecida com o RRAS redistribuível exporta a função como RasAdminPortEnum em vez de MprAdminPortEnum. Portanto, ao usar o RRAS redistribuível, use LoadLibrary e GetProcAddress para acessar essa função.

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	mprapi.h
Biblioteca	Mprapi.lib
DLL	Mprapi.dll