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

  • Статья

Функция MprAdminPortGetInfo получает сведения для определенного порта.

Синтаксис

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

Параметры

[in] hRasServer

Дескриптор на компьютере сервера RAS, на котором собирается информация о портах. Получите этот дескриптор, вызвав MprAdminServerConnect.

[in] dwLevel

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

Значение Формат структуры
0 RAS_PORT_0
1 RAS_PORT_1

[in] hPort

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

[out] lplpbBuffer

При успешном завершении — указатель на структуру, описывающую порт. Эти структуры имеют тип RAS_PORT_0 или RAS_PORT_1 в зависимости от значения параметра dwLevel . Освободите эту память, вызвав MprAdminBufferFree.

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

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

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

Значение Значение
ERROR_ACCESS_DENIED
 Вызывающее приложение не имеет достаточных привилегий.
ERROR_DDM_NOT_RUNNING
 Диспетчер номера по запросу (DDM) не запущен, возможно, потому, что диспетчер динамических интерфейсов (DIM) настроен для работы только по локальной сети.
ERROR_INVALID_PARAMETER
 По крайней мере один из следующих параметров имеет значение NULL или не указывает на допустимую память: lplpBuffer, lpdwEntriesRead или lpdwTotalEntries.
ERROR_INVALID_PORT_HANDLE
 Недопустимый параметр hPort .
ERROR_NOT_SUPPORTED
 Параметр dwLevel не равен нулю.
Другое
 Ошибка из MprError.h, RasError.h или WinError.h.
 
 

Комментарии

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

Требования

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

См. также раздел

MprAdminBufferFree

MprAdminPortEnum

MprAdminServerConnect

Функции администрирования RAS

Справочник по администрированию службы удаленного доступа