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

Статья
08/24/2023

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

Синтаксис

DWORD MprConfigInterfaceGetInfo(
  [in]      HANDLE  hMprConfig,
  [in]      HANDLE  hRouterInterface,
  [in]      DWORD   dwLevel,
  [in, out] LPBYTE  *lplpBuffer,
  [out]     LPDWORD lpdwBufferSize
);

Параметры

[in] hMprConfig

Дескриптор конфигурации маршрутизатора. Получите этот дескриптор, вызвав mprConfigServerConnect.

[in] hRouterInterface

Дескриптор конфигурации интерфейса, для которого требуется получить сведения. Получите этот дескриптор, вызвав MprConfigInterfaceCreate, MprConfigInterfaceGetHandle или MprConfigInterfaceEnum.

[in] dwLevel

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

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

[in, out] lplpBuffer

На входных данных — указатель, отличный от NULL .

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

[out] lpdwBufferSize

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

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

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

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

Значение	Значение
ERROR_INVALID_PARAMETER	Хотя бы одно из следующих утверждений верно: hMprConfig имеет значение NULL hRouterInterface имеет значение NULL Значение dwLevel не равно 0, 1, 2 или 3. lplpBuffer имеет значение NULL lpdwBufferSize имеет значение NULL
ERROR_NOT_ENOUGH_MEMORY	Недостаточно ресурсов для завершения операции.
ERROR_NO_SUCH_INTERFACE	Интерфейс, соответствующий hRouterInterface , отсутствует в конфигурации маршрутизатора.

Требования


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