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

Статья
08/24/2023

Функция MprAdminInterfaceGetInfo извлекает сведения для указанного интерфейса на указанном сервере.

Синтаксис

DWORD MprAdminInterfaceGetInfo(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] DWORD             dwLevel,
  [in] LPBYTE            *lplpbBuffer
);

Параметры

[in] hMprServer

Выполните запрос к маршрутизатору. Этот дескриптор получен из предыдущего вызова MprAdminServerConnect.

[in] hInterface

Обработка интерфейса, полученного при предыдущем вызове MprAdminInterfaceCreate.

[in] dwLevel

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

Значение	Формат структуры
0	MPR_INTERFACE_0
1	MPR_INTERFACE_1
2	MPR_INTERFACE_2
3	Windows Server 2008 или более поздней версии: MPR_INTERFACE_3

Значения 1, 2 и 3 допустимы только для интерфейсов типа ROUTER_CONNECTION_STATE.

[in] lplpbBuffer

Указатель на MPR_INTERFACE_0 , MPR_INTERFACE_1
структура MPR_INTERFACE_2 или MPR_INTERFACE_3 . Параметр dwLevel указывает тип структуры. Освободите эту память, вызвав MprAdminBufferFree.

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

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

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

Значение	Значение
ERROR_ACCESS_DENIED	Вызывающее приложение не имеет достаточных привилегий.
ERROR_INVALID_LEVEL	DwLevel имеет значение 2, но этот уровень не поддерживается для интерфейса. Например, тип интерфейса, определенный в структуре MPR_INTERFACE_X, не IF_TYPE_FULL_ROUTER.
ERROR_INVALID_HANDLE	Недопустимое значение hInterface .
ERROR_INVALID_PARAMETER	Параметр lplpbBuffer имеет значение NULL.
ERROR_NOT_ENOUGH_MEMORY	Недостаточно ресурсов для завершения операции.
ERROR_NOT_SUPPORTED	Недопустимое значение dwLevel .

Требования

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