Edit

DhcpEnumSubnetElements function (dhcpsapi.h)

  • Article

The DhcpEnumSubnetElements function returns an enumerated list of elements for a specific DHCP subnet.

Syntax

DWORD DHCP_API_FUNCTION DhcpEnumSubnetElements(
  [in]      DHCP_CONST WCHAR                 *ServerIpAddress,
  [in]      DHCP_IP_ADDRESS                  SubnetAddress,
  [in]      DHCP_SUBNET_ELEMENT_TYPE         EnumElementType,
  [in, out] DHCP_RESUME_HANDLE               *ResumeHandle,
  [in]      DWORD                            PreferredMaximum,
  [out]     LPDHCP_SUBNET_ELEMENT_INFO_ARRAY *EnumElementInfo,
  [out]     DWORD                            *ElementsRead,
  [out]     DWORD                            *ElementsTotal
);

Parameters

[in] ServerIpAddress

Unicode string that specifies the IPv4 address of the DHCP server.

[in] SubnetAddress

DHCP_IP_ADDRESS value that specifies the address of the IPv4 subnet whose elements will be enumerated.

[in] EnumElementType

DHCP_SUBNET_ELEMENT_TYPE enumeration value that indicates the type of subnet element to enumerate.

[in, out] ResumeHandle

Pointer to a DHCP_RESUME_HANDLE value that identifies the enumeration operation. Initially, this value should be zero, with a successful call returning the handle value used for subsequent enumeration requests. For example, if PreferredMaximum is set to 1000 bytes, and 2000 bytes worth of subnet elements are stored on the server, the resume handle can be used after the first 1000 bytes are retrieved to obtain the next 1000 on a subsequent call, and so forth.

The presence of additional enumerable data is indicated when this function returns ERROR_MORE_DATA. If no additional enumerable data is available on the DHCPv4 server, ERROR_NO_MORE_ITEMS is returned.

[in] PreferredMaximum

Specifies the preferred maximum number of bytes of subnet elements to return. If the number of remaining unenumerated options (in bytes) is less than this value, then that amount will be returned.

To retrieve all the subnet client elements for the default user and vendor class at the specified level, set this parameter to 0xFFFFFFFF.

[out] EnumElementInfo

Pointer to a pointer to a DHCP_SUBNET_ELEMENT_INFO_ARRAY structure containing an enumerated list of all elements available for the specified subnet. If no elements are available for enumeration, this value will be null.

[out] ElementsRead

Pointer to a DWORD value that specifies the number of subnet elements returned in EnumElementInfo.

[out] ElementsTotal

Pointer to a DWORD value that specifies the total number of as-yet unenumerated elements remaining on the server for the specified subnet.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Return code Description
ERROR_DHCP_JET_ERROR
 An error occurred while accessing the DHCP server database.
ERROR_MORE_DATA
 There are more elements available to enumerate.
ERROR_NO_MORE_ITEMS
 There are no more elements left to enumerate.
ERROR_DHCP_SUBNET_NOT_PRESENT
 The specified IPv4 subnet does not exist on the DHCP server.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll

See also

DHCP_SUBNET_ELEMENT_INFO_ARRAY

DHCP_SUBNET_ELEMENT_TYPE

DhcpEnumSubnetElementsV4

DhcpEnumSubnetElementsV5