dhcpEnumOptionValuesV5 函数 (dhcpsapi.h)

DhcpEnumOptionValuesV5 函数返回选项值的枚举列表, (给定用户或供应商类中特定范围) 选项数据和关联的 ID 号。

语法

DWORD DhcpEnumOptionValuesV5(
  [in]      LPWSTR                    ServerIpAddress,
  [in]      DWORD                     Flags,
  [in]      LPWSTR                    ClassName,
  [in]      LPWSTR                    VendorName,
  [in]      LPDHCP_OPTION_SCOPE_INFO  ScopeInfo,
  [in, out] DHCP_RESUME_HANDLE        *ResumeHandle,
  [in]      DWORD                     PreferredMaximum,
  [out]     LPDHCP_OPTION_VALUE_ARRAY *OptionValues,
  [out]     DWORD                     *OptionsRead,
  [out]     DWORD                     *OptionsTotal
);

参数

[in] ServerIpAddress

Unicode 字符串,指定 DHCP 服务器的 IP 地址或主机名。

[in] Flags

指定一个位标志,指示选项是否特定于供应商。 如果它不是特定于供应商的,则此参数必须为 0。

含义
0x00000000
为默认供应商类枚举选项值。
DHCP_FLAGS_OPTION_IS_VENDOR
0x00000003
为特定供应商类枚举选项值。

[in] ClassName

指向 Unicode 字符串的指针,该字符串包含将枚举其范围选项值的类的名称。

[in] VendorName

指向包含类供应商名称的 Unicode 字符串的指针。 此参数是可选的。 如果未提供供应商类名称,则为默认供应商类枚举选项值。

[in] ScopeInfo

指向 DHCP_OPTION_SCOPE_INFO 结构的指针,该结构包含为其定义选项值的作用域。 此值定义将从服务器、范围或默认级别或 IPv4 预留检索的选项值。

[in, out] ResumeHandle

指向标识枚举操作 DHCP_RESUME_HANDLE 值的指针。 最初,此值应为零,成功调用返回用于后续枚举请求的句柄值。 例如,如果 PreferredMaximum 设置为 1000 字节,并且服务器上存储了 2000 字节的选项值,则可以在检索前 1000 个字节后使用恢复句柄,以便在后续调用中获取下一个 1000 个字节,依此类推。

[in] PreferredMaximum

指定要返回的选项值的首选最大字节数。 如果 (的剩余未使用选项数(以字节为单位)) 小于此值,则返回所有选项值。

[out] OptionValues

指向 DHCP_OPTION_VALUE_ARRAY 结构的指针,该结构包含为指定范围返回的枚举选项值。 如果 DHCP 服务器上没有可用于此作用域的选项值,则此参数将返回 null。

[out] OptionsRead

指向 DWORD 值的指针,该值指定 OptionValues 中返回的选项值的数目。

[out] OptionsTotal

指向 DWORD 值的指针,该值指定 DHCP 服务器上存储的此范围尚未使用的选项值的总数。

返回值

此函数在调用成功后返回 ERROR_SUCCESS 。 否则,它将返回 DHCP 服务器管理 API 错误代码之一。

返回代码 说明
ERROR_ACCESS_DENIED
此调用由不是“DHCP 管理员”安全组成员的客户端执行。
ERROR_DHCP_CLASS_NOT_FOUND
提供的用户或供应商类名称不正确或未知。
ERROR_DHCP_SUBNET_NOT_PRESENT
DHCP 服务器上未定义指定的 IPv4 子网。
ERROR_DHCP_NOT_RESERVED_CLIENT
指定的 DHCP 客户端不是保留客户端。

要求

   
最低受支持的客户端 无受支持的版本
最低受支持的服务器 Windows Server 2008 R2 [仅限桌面应用]
目标平台 Windows
标头 dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll

请参阅

DHCP_OPTION_SCOPE_INFO

DHCP_OPTION_VALUE_ARRAY