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

Статья
03/15/2023

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

Синтаксис

DWORD MprConfigTransportSetInfo(
  [in]           HANDLE hMprConfig,
  [in]           HANDLE hRouterTransport,
  [in, optional] LPBYTE pGlobalInfo,
  [in, optional] DWORD  dwGlobalInfoSize,
  [in, optional] LPBYTE pClientInterfaceInfo,
  [in, optional] DWORD  dwClientInterfaceInfoSize,
  [in, optional] LPWSTR lpwsDLLPath
);

Параметры

[in] hMprConfig

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

[in] hRouterTransport

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

[in, optional] pGlobalInfo

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

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

[in, optional] dwGlobalInfoSize

Указывает размер (в байтах) данных, на которые указывает pGlobalInfo. Если вызывающее приложение задает значение NULL для pGlobalInfo, вызывающее приложение должно указать ноль для этого параметра.

[in, optional] pClientInterfaceInfo

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

[in, optional] dwClientInterfaceInfoSize

Задает размер (в байтах) данных, на которые указывает pClientInterfaceInfo. Если вызывающее приложение задает значение NULL для pClientInterfaceInfo, вызывающее приложение должно указать ноль для этого параметра.

[in, optional] lpwsDLLPath

Указатель на строку Юникода, завершающуюся null, которая указывает имя библиотеки DLL диспетчера маршрутизатора для указанного транспорта.

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

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

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

Значение	Значение
ERROR_INVALID_PARAMETER	Параметр hMprConfig имеет значение NULL, параметр hRouterTransport имеет значение NULL или оба параметра имеют значение NULL.
ERROR_UNKNOWN_PROTOCOL_ID	Конфигурация транспортного протокола, соответствующая hRouterTransport , не найдена в конфигурации маршрутизатора.
Другое	Используйте FormatMessage , чтобы получить системное сообщение об ошибке, соответствующее возвращаемому коду ошибки.

Используйте MprConfigTransportSetInfo , чтобы задать глобальные сведения о транспорте, сведения об интерфейсе по умолчанию или имя библиотеки DLL диспетчера маршрутизатора для транспорта.

MprConfigTransportSetInfo пытается задать элементы в порядке их отображения в списке параметров:

Глобальная информация.
Сведения об интерфейсе по умолчанию для клиентских маршрутизаторов.
Имя DLL диспетчера маршрутизатора.

Если MprConfigTransportSetInfo не удается задать какой-либо из элементов, он возвращается немедленно, не пытаясь задать оставшиеся элементы.

Если параметры pGlobalInfo, pClientInterfaceInfo и lpwsDLLPath имеют значение NULL, функция ничего не делает, возвращая значение NO_ERROR.

Требования

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