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

Статья
08/24/2023

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

Синтаксис

DWORD MprConfigInterfaceSetInfo(
  [in] HANDLE hMprConfig,
  [in] HANDLE hRouterInterface,
  [in] DWORD  dwLevel,
  [in] LPBYTE lpbBuffer
);

Параметры

[in] hMprConfig

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

[in] hRouterInterface

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

[in] dwLevel

Значение DWORD, описывающее формат, в котором данные структурированы в параметре lpBuffer . Допустимые значения для 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] lpbBuffer

Указатель на
MPR_INTERFACE_0, MPR_INTERFACE_1,
структура MPR_INTERFACE_2 или MPR_INTERFACE_3 . Параметр dwLevel указывает тип структуры. Сведения в этой структуре используются для обновления конфигурации интерфейса.

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

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

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

Значение	Значение
ERROR_INVALID_PARAMETER	Хотя бы одно из следующих утверждений верно: hMprConfig имеет значение NULL. hRouterInterface имеет значение NULL. Значение dwLevel не равно 0, 1, 2 или 3. lpBuffer имеет значение NULL. Также возвращает этот код ошибки, если интерфейс имеет тип ROUTER_IF_TYPE_DEDICATED или ROUTER_IF_TYPE_INTERNAL и интерфейс включен.
ERROR_NO_SUCH_INTERFACE	Интерфейс, соответствующий hRouterInterface , отсутствует в конфигурации маршрутизатора.
Другое	Используйте FormatMessage , чтобы получить системное сообщение об ошибке, соответствующее возвращаемому коду ошибки.

Функция MprAdminInterfaceSetInfo поддерживает структуру MPR_INTERFACE_2 . Однако mprConfigInterfaceSetInfo этого не делает. Чтобы внести постоянные изменения в интерфейс вызова по запросу, вызовите MprAdminInterfaceSetInfo с MPR_INTERFACE_2, а затем вызовите MprConfigInterfaceSetInfo с MPR_INTERFACE_0 или MPR_INTERFACE_1.

Требования

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