Função MprAdminConnectionGetInfo (mprapi.h)

Artigo
02/29/2024

A função MprAdminConnectionGetInfo recupera dados sobre uma conexão específica.

Sintaxe

DWORD MprAdminConnectionGetInfo(
  [in]  RAS_SERVER_HANDLE hRasServer,
  [in]  DWORD             dwLevel,
  [in]  HANDLE            hRasConnection,
  [out] LPBYTE            *lplpbBuffer
);

Parâmetros

[in] hRasServer

Um identificador para o computador do qual as informações de conexão são recuperadas. 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 . Os valores aceitáveis para dwLevel incluem 0, 1, 2 e 3, conforme listado na tabela a seguir.

Windows NT 4.0: esse parâmetro deve ser zero.

Valor	Formato de estrutura
0	RAS_CONNECTION_0
1	Windows 2000 ou posterior: RAS_CONNECTION_1
2	Windows 2000 ou posterior: RAS_CONNECTION_2
3	Windows Server 2008 ou posterior: RAS_CONNECTION_3

[in] hRasConnection

Um identificador para a conexão sobre a qual recuperar dados. Para obter esse identificador, chame MprAdminConnectionEnum.

[out] lplpbBuffer

Após a conclusão bem-sucedida, um ponteiro para uma matriz de estruturas que descrevem a conexão. Essas estruturas são do tipo RAS_CONNECTION_0, RAS_CONNECTION_1, RAS_CONNECTION_2 ou RAS_CONNECTION_3, dependendo do valor do parâmetro dwLevel .

Para liberar essa memória, chame 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 códigos de erro listados na tabela a seguir.

Código de retorno	Descrição
ERROR_INVALID_PARAMETER	O identificador para o servidor RAS ou o identificador para a conexão RAS é inválido.
ERROR_INVALID_LEVEL	O valor passado para dwLevel não é zero, um, dois ou três. Os níveis um e dois têm suporte apenas no Windows 2000 ou posterior. O nível três tem suporte apenas no Windows Server 2008 ou posterior.
ERROR_INTERFACE_NOT_CONNECTED	O identificador hConnection é inválido.
RPC_S_INVALID_BINDING	O identificador hRasServer é inválido.
Outros	Um erro de MprError.h, RasError.h ou WinError.h.

Comentários

Essa função estará disponível no Windows NT 4.0 se o RRAS redistribuível estiver instalado. No entanto, a versão de Mprapi.dll incluída no RRAS redistribuível exporta a função como RasAdminConnectionGetInfo em vez de MprAdminConnectionGetInfo. 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