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

Статья
08/24/2023

Функция MprAdminTransportGetInfo извлекает глобальные сведения, сведения об интерфейсе клиента по умолчанию или и то, и другое для указанного транспорта.

Синтаксис

DWORD MprAdminTransportGetInfo(
  [in]            MPR_SERVER_HANDLE hMprServer,
  [in]            DWORD             dwTransportId,
  [out, optional] LPBYTE            *ppGlobalInfo,
  [out, optional] LPDWORD           lpdwGlobalInfoSize,
  [out, optional] LPBYTE            *ppClientInterfaceInfo,
  [out, optional] LPDWORD           lpdwClientInterfaceInfoSize
);

Параметры

[in] hMprServer

Дескриптор маршрутизатора, из которого извлекаются сведения. Этот дескриптор получен из предыдущего вызова MprAdminServerConnect.

[in] dwTransportId

Значение DWORD , описывающее тип транспорта для извлечения. Допустимые значения для dwTransportId перечислены в следующей таблице.

Значение	Транспорт (семейство протоколов)
PID_ATALK	Appletalk
PID_IP	Протокол ИНТЕРНЕТА версии 4
PID_IPX	Обмен пакетами в Интернете
PID_NBF	Протокол netBIOS-кадров
PID_IPV6	Windows Server 2008 или более поздней версии: протокол INTERNET версии 6

[out, optional] ppGlobalInfo

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

Освободите эту память, вызвав MprAdminBufferFree.

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

[out, optional] lpdwGlobalInfoSize

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

[out, optional] ppClientInterfaceInfo

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

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

[out, optional] lpdwClientInterfaceInfoSize

Указатель на переменную DWORD . Эта переменная получает размер в байтах сведений об интерфейсе клиента.

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

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

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

Значение	Значение
ERROR_ACCESS_DENIED	Вызывающее приложение не имеет достаточных привилегий.
ERROR_INVALID_PARAMETER	Выполняется одно из следующих условий. Параметры ppGlobalInfo и ppClientInterfaceInfo имеют значение NULL. Параметр ppGlobalInfo не указывает на допустимую память. Параметр ppClientInterfaceInfo не указывает на допустимую память.
ERROR_NOT_ENOUGH_MEMORY	Недостаточно ресурсов для завершения операции.
ERROR_UNKNOWN_PROTOCOL_ID	Значение dwTransportId не соответствует ни одному установленному транспорту.

Требования

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