Функция MprAdminConnectionEnumEx (mprapi.h)
Функция MprAdminConnectionEnumEx перечисляет активные подключения для указанного сервера RRAS.
Синтаксис
DWORD MprAdminConnectionEnumEx(
[in] RAS_SERVER_HANDLE hRasServer,
[in] PMPRAPI_OBJECT_HEADER pObjectHeader,
[in] DWORD dwPreferedMaxLen,
[out] LPDWORD lpdwEntriesRead,
[out] LPDWORD lpdwTotalEntries,
[out] PRAS_CONNECTION_EX *ppRasConn,
[in] LPDWORD lpdwResumeHandle
);
Параметры
[in] hRasServer
Дескриптор сервера RAS, на котором перечисляются подключения. Получите этот дескриптор, вызвав MprAdminServerConnect.
[in] pObjectHeader
Указатель на структуру MPRAPI_OBJECT_HEADER , указывающую версию структуры, полученную ppRasConn.
[in] dwPreferedMaxLen
Значение типа , указывающее предпочтительную максимальную длину возвращаемых данных в 8-разрядных байтах. Если dwPrefMaxLen имеет значение -1, возвращаемый буфер достаточно велик для хранения всех доступных сведений.
[out] lpdwEntriesRead
Указатель на DWORD , получающий общее количество соединений, перечисленных из текущей позиции возобновления.
[out] lpdwTotalEntries
Указатель на DWORD , получающий общее количество подключений, которые можно было перечислить из текущей позиции возобновления.
[out] ppRasConn
Указатель на выходных данных на массив RAS_CONNECTION_EX структур, содержащих сведения об активном подключении для сервера RRAS в hRasServer. Количество элементов массива определяется значением, на которое указывает lpdwEntriesRead.
[in] lpdwResumeHandle
Указатель на переменную DWORD , указывающую дескриптор возобновления, используемый для продолжения перечисления. Параметр lpdwResumeHandle имеет значение NULL при первом вызове и остается без изменений при последующих вызовах. Если код возврата ERROR_MORE_DATA, можно выполнить другой вызов с помощью этого дескриптора для получения дополнительных данных. Если при возврате дескриптор имеет значение NULL , перечисление завершается. Этот дескриптор недопустим для других типов возврата ошибок.
Возвращаемое значение
Если функция выполнена успешно, возвращаемое значение будет NO_ERROR.
Если функция завершается сбоем, возвращается один из следующих кодов ошибок.
Значение | Значение |
---|---|
|
Вызывающее приложение не имеет достаточных привилегий. |
|
Диспетчер вызова по запросу (DDM) не запущен. |
|
При этом вызове были возвращены не все данные. Чтобы получить дополнительные данные, снова вызовите функцию с помощью дескриптора возобновления. |
|
Не удалось найти указанную процедуру. |
|
Ошибка из mprError.h, RasError.h или WinError.h. |
Комментарии
Вызывающий объект должен освободить память, на которую указывает ppRasConn , вызвав функцию MprAdminBufferFree.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows 7 [только классические приложения] |
Минимальная версия сервера | Windows Server 2008 R2 [только классические приложения] |
Целевая платформа | Windows |
Header | mprapi.h |
Библиотека | Mprapi.lib |
DLL | Mprapi.dll |