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

Статья
08/24/2023

Функция MprAdminConnectionEnum перечисляет все активные подключения.

Синтаксис

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

Параметры

[in] hRasServer

Дескриптор на сервере RAS, на котором перечисляются подключения. Получите этот дескриптор, вызвав 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

[out] lplpbBuffer

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

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

[in] dwPrefMaxLen

Задает предпочтительную максимальную длину возвращаемых данных в 8-разрядных байтах. Если dwPrefMaxLen имеет значение -1, возвращаемый буфер достаточно велик для хранения всех доступных сведений.

[out] lpdwEntriesRead

Указатель на переменную DWORD . Эта переменная получает общее количество подключений, перечисленных из текущей позиции возобновления.

[out] lpdwTotalEntries

Указатель на переменную DWORD . Эта переменная получает общее количество подключений, которые можно было бы перечислить из текущей позиции возобновления.

[in] lpdwResumeHandle

Указатель на переменную DWORD . Эта переменная задает дескриптор возобновления, используемый для продолжения перечисления. Параметр lpdwResumeHandle равен нулю при первом вызове и остается без изменений при последующих вызовах. Если код возврата ERROR_MORE_DATA, можно выполнить другой вызов с помощью этого дескриптора для получения дополнительных данных. Если при возврате дескриптор имеет значение NULL , перечисление завершается. Этот дескриптор недопустим для других типов возврата ошибок.

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

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

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

Значение	Значение
ERROR_DDM_NOT_RUNNING	Диспетчер по запросу (DDM) не запущен, возможно, потому, что диспетчер динамических интерфейсов (DIM) настроен для запуска только по локальной сети.
ERROR_INVALID_LEVEL	Значение, переданное для dwLevel , не равно нулю, единице, двум или трем. Уровни один и два поддерживаются только в Windows 2000 или более поздней версии. Третий уровень поддерживается только в Windows Server 2008 или более поздней версии.
ERROR_INVALID_PARAMETER	По крайней мере один из следующих параметров имеет значение NULL или не указывает на допустимую память: lplpBuffer, lpdwEntriesRead или lpdwTotalEntries.
ERROR_MORE_DATA	При этом вызове были возвращены не все данные. Чтобы получить дополнительные данные, снова вызовите функцию с помощью дескриптора возобновления.
RPC_S_INVALID_BINDING	Дескриптор, передаваемый в параметре hRasServer , имеет значение NULL или недопустимый.
Другое	Ошибка из mprError.h, RasError.h или WinError.h.

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

Требования

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