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

Статья
08/24/2023

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

Синтаксис

DWORD MprConfigInterfaceTransportSetInfo(
  [in]           HANDLE hMprConfig,
  [in]           HANDLE hRouterInterface,
  [in]           HANDLE hRouterIfTransport,
  [in, optional] LPBYTE pInterfaceInfo,
  [in, optional] DWORD  dwInterfaceInfoSize
);

Параметры

[in] hMprConfig

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

[in] hRouterInterface

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

[in] hRouterIfTransport

Обработка конфигурации транспорта, в которой обновляется информация для клиента. Получите этот дескриптор, вызвав MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle или MprConfigInterfaceTransportEnum. Поддерживаемые типы транспортных протоколов перечислены в разделе Идентификаторы транспорта.

[in, optional] pInterfaceInfo

Указатель на заголовок сведений, содержащий сведения о конфигурации клиента по указанному интерфейсу и транспорту. Диспетчер маршрутизатора для указанного транспорта интерпретирует эти сведения. Используйте функции заголовков сведений для управления заголовками информации.

Этот параметр является необязательным. Если вызывающее приложение указывает значение NULL для этого параметра, функция не обновляет сведения о конфигурации для клиента.

[in, optional] dwInterfaceInfoSize

Указывает размер (в байтах) данных, на которые указывает pInterfaceInfo.

Этот параметр является необязательным; вызывающее приложение может указать ноль для этого параметра. Однако если pInterfaceInfo не имеет значение NULL, этот параметр не может быть равен нулю. Дополнительные сведения см. в подразделе «Примечания» далее в этом разделе.

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

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

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

Значение	Значение
ERROR_INVALID_PARAMETER	Хотя бы одно из следующих утверждений верно: hMprConfig имеет значение NULL. hRouterInterface имеет значение NULL. hRouterIfTransport имеет значение NULL.
ERROR_NO_SUCH_INTERFACE	Интерфейс, заданный параметром hRouterInterface , больше не присутствует в конфигурации маршрутизатора, или транспорт, заданный параметром hRouterInterface , больше не присутствует в интерфейсе.
Другое	Используйте FormatMessage , чтобы получить системное сообщение об ошибке, соответствующее возвращаемому коду ошибки.

Требования


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