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

Статья
08/24/2023

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

Синтаксис

DWORD MprAdminInterfaceEnum(
  [in]  MPR_SERVER_HANDLE hMprServer,
  [in]  DWORD             dwLevel,
  [out] LPBYTE            *lplpbBuffer,
  [in]  DWORD             dwPrefMaxLen,
  [out] LPDWORD           lpdwEntriesRead,
  [out] LPDWORD           lpdwTotalEntries,
  [in]  LPDWORD           lpdwResumeHandle
);

Параметры

[in] hMprServer

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

[in] dwLevel

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

[out] lplpbBuffer

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

[in] dwPrefMaxLen

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

[out] lpdwEntriesRead

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

[out] lpdwTotalEntries

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

[in] lpdwResumeHandle

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

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

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

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

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

Значение	Значение
ERROR_ACCESS_DENIED	Вызывающее приложение не имеет достаточных привилегий.
ERROR_MORE_DATA	Дополнительные сведения доступны; перечисление можно продолжить.
ERROR_NOT_ENOUGH_MEMORY	Недостаточно ресурсов для завершения операции.
ERROR_NOT_SUPPORTED	Недопустимое значение dwLevel .

Требования

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

См. также раздел

MPR_INTERFACE_0

MprAdminBufferFree

MprAdminServerConnect

Функции администрирования маршрутизатора

Справочник по управлению маршрутизаторами

Поделиться через