Функция MprConfigTransportGetInfo (mprapi.h)
Функция MprConfigTransportGetInfo извлекает конфигурацию для указанного транспортного протокола из маршрутизатора.
Синтаксис
DWORD MprConfigTransportGetInfo(
[in] HANDLE hMprConfig,
[in] HANDLE hRouterTransport,
[in, out, optional] LPBYTE *ppGlobalInfo,
[out, optional] LPDWORD lpdwGlobalInfoSize,
[in, out, optional] LPBYTE *ppClientInterfaceInfo,
[out, optional] LPDWORD lpdwClientInterfaceInfoSize,
[in, out, optional] LPWSTR *lplpwsDLLPath
);
Параметры
[in] hMprConfig
Дескриптор конфигурации маршрутизатора. Получите этот дескриптор, вызвав mprConfigServerConnect.
[in] hRouterTransport
Дескриптор извлекаемой конфигурации транспортного протокола. Получите этот дескриптор, вызвав MprConfigTransportCreate, MprConfigTransportGetHandle или MprConfigTransportEnum. Поддерживаемые типы транспортных протоколов перечислены в разделе Идентификаторы транспорта.
[in, out, optional] ppGlobalInfo
На входных данных указатель на переменную указателя.
В выходных данных эта переменная указателя указывает на заголовок сведений, содержащий глобальные сведения о транспорте. Используйте функции заголовков сведений для управления заголовками информации. Освободите этот буфер, вызвав MprConfigBufferFree.
Этот параметр является необязательным. Если вызывающее приложение задает значение NULL для этого параметра, функция не получает глобальные сведения.
[out, optional] lpdwGlobalInfoSize
Указатель на переменную DWORD . Эта переменная получает размер (в байтах) буфера, возвращаемого с помощью параметра ppGlobalInfo .
Этот параметр является необязательным; Вызывающее приложение может указать значение NULL для этого параметра. Однако если параметр ppGlobalInfo не имеет значение NULL, этот параметр не может иметь значение NULL.
[in, out, optional] ppClientInterfaceInfo
На входных данных указатель на переменную указателя.
На выходе этот указатель указывает на заголовок сведений, содержащий сведения об интерфейсе по умолчанию для клиентских маршрутизаторов для этого транспорта. Используйте функции заголовков сведений для управления заголовками информации. Освободите буфер, вызвав MprConfigBufferFree.
Этот параметр является необязательным. Если вызывающее приложение указывает значение NULL для этого параметра, функция не получает сведения об интерфейсе.
[out, optional] lpdwClientInterfaceInfoSize
Указатель на переменную DWORD . Эта переменная получает размер (в байтах) буфера, возвращаемого с помощью параметра ppClientInterfaceInfo .
Этот параметр является необязательным; Вызывающее приложение может указать значение NULL для этого параметра. Однако если параметр ppClientInterfaceInfo не равен NULL, этот параметр не может иметь значение NULL.
[in, out, optional] lplpwsDLLPath
На входных данных — указатель на строку Юникода, завершаемую null.
В выходных данных строка Юникода получает имя библиотеки DLL диспетчера маршрутизатора для указанного транспорта.
Этот параметр является необязательным. Если вызывающее приложение указывает значение NULL для этого параметра, функция не получает имя библиотеки DLL диспетчера маршрутизатора.
Возвращаемое значение
Если функция выполняется успешно, возвращаемое значение будет NO_ERROR.
Если функция завершается сбоем, возвращаемое значение представляет собой один из следующих кодов ошибок.
| Значение | Значение |
|---|---|
|
Хотя бы одно из следующих утверждений верно:
|
|
Конфигурация транспортного протокола, соответствующая hRouterTransport , не найдена в конфигурации маршрутизатора. |
|
Недостаточно ресурсов для завершения операции. |
|
Используйте FormatMessage , чтобы получить системное сообщение об ошибке, соответствующее возвращаемому коду ошибки. |
Комментарии
Если параметры pGlobalInfo, pClientInterfaceInfo и lpwsDLLPath имеют значение NULL, функция ничего не делает и возвращает значение NO_ERROR.
Требования
| Минимальная версия клиента | Ни одна версия не поддерживается |
| Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
| Целевая платформа | Windows |
| Header | mprapi.h |
| Библиотека | Mprapi.lib |
| DLL | Mprapi.dll |