Функция DhcpV4EnumPolicies (dhcpsapi.h)

2024-03-05

Функция DhcpV4EnumPolicies перечисляет политики, настроенные на DHCP-сервере.

Синтаксис

DWORD DHCP_API_FUNCTION DhcpV4EnumPolicies(
  [in, optional] LPWSTR              ServerIpAddress,
  [in, out]      LPDWORD             ResumeHandle,
  [in]           DWORD               PreferredMaximum,
  [in]           BOOL                fGlobalPolicy,
  [in]           DHCP_IP_ADDRESS     SubnetAddress,
  [out]          LPDHCP_POLICY_ARRAY *EnumInfo,
  [out]          DWORD               *ElementsRead,
  [out]          DWORD               *ElementsTotal
);

Параметры

[in, optional] ServerIpAddress

Указатель на строку Юникода с пустым завершением, представляющую IP-адрес или имя узла DHCP-сервера.

[in, out] ResumeHandle

Указатель на структуру DHCP_RESUME_HANDLE , которая идентифицирует это перечисление для использования в последующих вызовах этой функции.

Изначально это значение должно быть равным нулю на входных данных. В случае успешного выполнения возвращаемое значение следует использовать для последующих запросов перечисления. Например, если для PreferredMaximum задано значение 100, а на сервере настроено 200 политик, дескриптор возобновления можно использовать после получения первых 100 политик для получения следующих 100 при последующем вызове.

[in] PreferredMaximum

Максимальное число возвращаемых структур политики в EnumInfo. Если значение PreferredMaximum больше, чем количество оставшихся неперечисленных политик на сервере, возвращается оставшееся число неперечисленных политик.

[in] fGlobalPolicy

Если значение РАВНО TRUE , то перечисляется политика уровня сервера. В противном случае будет перечислена политика уровня область.

[in] SubnetAddress

DHCP_IP_ADDRESS структура, содержащая IPv4-адрес подсети перечисляемых политик.

[out] EnumInfo

Указатель на структуру DHCP_POLICY_ARRAY , содержащую политики, доступные на DHCP-сервере. Если политики не настроены, это значение равно NULL.

[out] ElementsRead

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

[out] ElementsTotal

Указатель на DWORD , указывающий количество политик, настроенных на DHCP-сервере, которые еще не были перечислены.

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

Если функция завершается успешно, она возвращает ERROR_SUCCESS.

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

Значение	Значение
ERROR_MORE_DATA	Существует больше элементов, доступных для перечисления.
ERROR_NO_MORE_ITEMS	Больше не осталось элементов для перечисления.

Требования

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