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

Статья
08/24/2023

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

Синтаксис

DWORD MprConfigInterfaceTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                HANDLE  hRouterIfTransport,
  [in, out, optional] LPBYTE  *ppInterfaceInfo,
  [out, optional]     LPDWORD lpdwInterfaceInfoSize
);

Параметры

[in] hMprConfig

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

[in] hRouterInterface

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

[in] hRouterIfTransport

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

[in, out, optional] ppInterfaceInfo

На входных данных указатель на переменную указателя.

В выходных данных эта переменная указателя указывает на заголовок сведений, содержащий сведения о конфигурации для клиента. Используйте функции заголовков сведений для управления заголовками информации. Освободите эту память, вызвав MprConfigBufferFree.

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

[out, optional] lpdwInterfaceInfoSize

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

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

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

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

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

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

Требования


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