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

Статья
02/29/2024

Функция DhcpV4GetPolicy извлекает политику с DHCP-сервера.

Синтаксис

DWORD DHCP_API_FUNCTION DhcpV4GetPolicy(
  [in, optional] LPWSTR          ServerIpAddress,
  [in]           BOOL            fGlobalPolicy,
  [in]           DHCP_IP_ADDRESS SubnetAddress,
  [in]           LPWSTR          PolicyName,
  [out]          LPDHCP_POLICY   *Policy
);

Параметры

[in, optional] ServerIpAddress

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

[in] fGlobalPolicy

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

[in] SubnetAddress

DHCP_IP_ADDRESS структура, содержащая IPv4-адрес подсети извлекаемой политики.

[in] PolicyName

Строка Юникода, завершающаяся значением NULL, представляющая имя извлекаемой политики.

[out] Policy

Указатель на структуру DHCP_POLICY , содержащую параметры политики, запрошенные в PolicyName.

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

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

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

Значение	Значение
ERROR_INVALID_PARAMETER	Один или несколько параметров были недопустимы.
ERROR_DHCP_SUBNET_NOT_PRESENT	Указанная подсеть IPv4 не существует.
ERROR_DHCP_POLICY_NOT_FOUND	Политика DHCP-сервера не найдена.

Требования

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