Функция MprAdminConnectionGetInfo (mprapi.h)

Статья
08/24/2023

Функция MprAdminConnectionGetInfo извлекает данные об определенном соединении.

Синтаксис

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

Параметры

[in] hRasServer

Дескриптор компьютера, с которого извлекаются сведения о подключении. Чтобы получить этот дескриптор, вызовите mprAdminServerConnect.

[in] dwLevel

Значение DWORD, описывающее формат, в котором возвращаются сведения в параметре lplpbBuffer . Допустимые значения для dwLevel включают 0, 1, 2 и 3, как указано в следующей таблице.

Windows NT 4.0: этот параметр должен быть равен нулю.

Значение	Формат структуры
0	RAS_CONNECTION_0
1	Windows 2000 или более поздней версии: RAS_CONNECTION_1
2	Windows 2000 или более поздней версии: RAS_CONNECTION_2
3	Windows Server 2008 или более поздней версии: RAS_CONNECTION_3

[in] hRasConnection

Дескриптор соединения для получения данных. Чтобы получить этот дескриптор, вызовите mprAdminConnectionEnum.

[out] lplpbBuffer

При успешном завершении — указатель на массив структур, описывающих соединение. Эти структуры имеют тип RAS_CONNECTION_0, RAS_CONNECTION_1, RAS_CONNECTION_2 или RAS_CONNECTION_3 в зависимости от значения параметра dwLevel .

Чтобы освободить эту память, вызовите MprAdminBufferFree.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение будет NO_ERROR.

Если функция завершается сбоем, возвращаемое значение является одним из кодов ошибок, перечисленных в следующей таблице.

Код возврата	Описание
ERROR_INVALID_PARAMETER	Дескриптор сервера RAS или дескриптор подключения RAS недопустим.
ERROR_INVALID_LEVEL	Значение, переданное для dwLevel , не равно нулю, единице, двум или трем. Уровни один и два поддерживаются только в Windows 2000 или более поздних версий. Третий уровень поддерживается только в Windows Server 2008 или более поздней версии.
ERROR_INTERFACE_NOT_CONNECTED	Недопустимый дескриптор hConnection .
RPC_S_INVALID_BINDING	Недопустимый дескриптор hRasServer .
Другое	Ошибка из MprError.h, RasError.h или WinError.h.

Эта функция доступна в Windows NT 4.0, если установлен распространяемый компонент RRAS. Однако версия Mprapi.dll, включенная в распространяемый компонент RRAS, экспортирует функцию как RasAdminConnectionGetInfo , а не mprAdminConnectionGetInfo. Поэтому при использовании распространяемого компонента RRAS используйте LoadLibrary и GetProcAddress для доступа к этой функции.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	mprapi.h
Библиотека	Mprapi.lib
DLL	Mprapi.dll