Функция MprAdminPortEnum (mprapi.h)
Функция MprAdminPortEnum перечисляет все активные порты в определенном подключении или все порты, доступные для использования или используемые в настоящее время RAS.
Синтаксис
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
);
Параметры
[in] hRasServer
Дескриптор сервера RAS, порты которого необходимо перечислить. Чтобы получить этот дескриптор, вызовите MprAdminServerConnect.
[in] dwLevel
Значение DWORD, описывающее формат, в котором возвращаются сведения в параметре lplpbBuffer . Должен равняться нулю.
[in] hRasConnection
Дескриптор подключения, для которого перечисляются активные порты. Если этот параметр INVALID_HANDLE_VALUE, перечисляются все порты, используемые или доступные для использования RRAS. Чтобы получить этот дескриптор, вызовите MprAdminConnectionEnum.
[out] lplpbBuffer
При успешном завершении указатель на массив RAS_PORT_0 структур, описывающих порт. Освободите эту память, вызвав MprAdminBufferFree.
[in] dwPrefMaxLen
Значение типа , указывающее предпочтительную максимальную длину возвращаемых данных в 8-разрядных байтах. Если этот параметр равен -1, возвращаемый буфер достаточно велик для хранения всех доступных данных.
[out] lpdwEntriesRead
Указатель на переменную DWORD . Эта переменная получает общее количество портов, которые перечисляются из текущей позиции возобновления.
[out] lpdwTotalEntries
Указатель на переменную DWORD . Эта переменная получает общее количество портов, которые можно было бы перечислить из текущей позиции возобновления.
[in] lpdwResumeHandle
Указатель на переменную DWORD . При успешном выполнении этот параметр указывает дескриптор, который можно использовать для возобновления перечисления. Этот параметр должен быть равен нулю при первом вызове и оставить без изменений при последующих вызовах. Если код возврата ERROR_MORE_DATA, вызов можно повторно отправить с помощью дескриптора, чтобы получить дополнительные данные. Если дескриптор имеет значение NULL при возврате, перечисление невозможно продолжить. Этот дескриптор недопустим для других типов возврата ошибок.
Возвращаемое значение
Если функция выполнена успешно, возвращаемое значение будет NO_ERROR.
Если функция завершается сбоем, возвращаемое значение является одним из кодов ошибок, перечисленных в следующей таблице.
| Значение | Значение |
|---|---|
|
Вызывающее приложение не имеет достаточных привилегий. |
|
Диспетчер по запросу (DDM) не запущен, возможно, потому, что диспетчер динамических интерфейсов (DIM) настроен для запуска только по локальной сети. |
|
По крайней мере один из следующих параметров имеет значение NULL или не указывает на допустимую память: lplpBuffer, lpdwEntriesRead или lpdwTotalEntries. |
|
При этом вызове были возвращены не все данные. Чтобы получить дополнительные данные, снова вызовите функцию с помощью дескриптора, возвращенного в параметре IpdwResumeHandle . |
|
Параметр dwLevel не равен нулю. |
|
Параметр hConnection имеет значение NULL. |
|
Ошибка из mprError.h, RasError.h или WinError.h. |
Комментарии
Если установлен распространяемый компонент RRAS, эта функция доступна в Windows NT 4.0. Однако версия Mprapi.dll, которая предоставляется вместе с распространяемым компонентом RRAS, экспортирует функцию как RasAdminPortEnum , а не mprAdminPortEnum. Поэтому при использовании распространяемого компонента RRAS используйте LoadLibrary и GetProcAddress для доступа к этой функции.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows 2000 Professional [только классические приложения] |
| Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
| Целевая платформа | Windows |
| Header | mprapi.h |
| Библиотека | Mprapi.lib |
| DLL | Mprapi.dll |