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

Статья
08/24/2023

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

Синтаксис

DWORD MprConfigServerGetInfo(
  [in]  HANDLE hMprConfig,
  [in]  DWORD  dwLevel,
  [out] LPBYTE *lplpbBuffer
);

Параметры

[in] hMprConfig

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

[in] dwLevel

Значение DWORD, описывающее формат, в котором возвращаются сведения в параметре lplpBuffer . Допустимые значения для dwLevel включают 0, 1 и 2, как указано в следующей таблице.

Значение	Формат структуры
0	Windows 2000 Server или более поздней версии: MPR_SERVER_0
1	Windows Server 2003 или более поздней версии: MPR_SERVER_1
2	Windows Server 2008 или более поздней версии: MPR_SERVER_2

[out] lplpbBuffer

При успешном завершении указатель на MPR_SERVER_0 MPR_SERVER_1
или MPR_SERVER_2 структуры. Параметр dwLevel указывает тип структуры. Освободите память для этого буфера с помощью MprConfigBufferFree.

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

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

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

Значение	Значение
ERROR_INVALID_PARAMETER	Хотя бы одно из следующих утверждений верно: Параметр hMprConfig имеет значение NULL. Параметр dwLevel не равен нулю. Параметр lplpBuffer имеет значение NULL.
ERROR_NOT_ENOUGH_MEMORY	Недостаточно ресурсов для завершения операции.
Другое	Используйте FormatMessage , чтобы получить системное сообщение об ошибке, соответствующее возвращаемому коду ошибки.

Требования

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