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

Статья
08/24/2023

Функция MprConfigInterfaceTransportEnum перечисляет транспорты, настроенные в указанном интерфейсе.

Синтаксис

DWORD MprConfigInterfaceTransportEnum(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                DWORD   dwLevel,
  [in, out]           LPBYTE  *lplpBuffer,
  [in]                DWORD   dwPrefMaxLen,
  [out]               LPDWORD lpdwEntriesRead,
  [out]               LPDWORD lpdwTotalEntries,
  [in, out, optional] LPDWORD lpdwResumeHandle
);

Параметры

[in] hMprConfig

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

[in] hRouterInterface

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

[in] dwLevel

Значение DWORD , описывающее формат, в котором возвращаются сведения в параметре lplpBuffer . Должен равняться нулю.

[in, out] lplpBuffer

На входных данных — указатель, отличный от NULL .

При успешном завершении указатель на массив MPR_IFTRANSPORT_0 структур. Освободите этот буфер памяти, вызвав MprConfigBufferFree.

[in] dwPrefMaxLen

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

[out] lpdwEntriesRead

Указатель на переменную DWORD . Эта переменная получает общее количество записей, которые были перечислены из текущей позиции возобновления.

[out] lpdwTotalEntries

Указатель на переменную DWORD . Эта переменная получает общее количество записей, которые можно было бы перечислить из текущей позиции резюме.

[in, out, optional] lpdwResumeHandle

Указатель на переменную DWORD .

При входе дескриптор должен быть равен нулю при первом вызове и оставить без изменений при последующих вызовах.

В выходных данных эта переменная содержит дескриптор возобновления, используемый для продолжения перечисления. Если дескриптор имеет значение NULL, перечисление завершается.

Если в перечислении возникает ошибка, этот дескриптор недопустим.

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

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

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

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

Значение	Значение
ERROR_INVALID_PARAMETER	Выполняется одно из следующих условий. hMprConfig имеет значение NULL. HRouterInterface имеет значение NULL. DwLevel не равен нулю. lplpBuffer имеет значение NULL. DwPrefMaxLen меньше размера одной структуры MPR_IFTRANSPORT_0 . lpdwEntriesRead имеет значение NULL. lpdwTotalEntries имеет значение NULL.
ERROR_NOT_ENOUGH_MEMORY	Недостаточно ресурсов для завершения операции.
ERROR_NO_MORE_ITEMS	Больше нет доступных записей из текущей позиции резюме.
Другое	Используйте FormatMessage , чтобы получить системное сообщение об ошибке, соответствующее возвращаемому коду ошибки.

Требования


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