DhcpEnumSubnetClients function (dhcpsapi.h)

The DhcpEnumSubnetClients function returns an enumerated list of clients with served IP addresses in the specified subnet.

Syntax

DWORD DHCP_API_FUNCTION DhcpEnumSubnetClients(
  [in]      DHCP_CONST WCHAR         *ServerIpAddress,
  [in]      DHCP_IP_ADDRESS          SubnetAddress,
  [in, out] DHCP_RESUME_HANDLE       *ResumeHandle,
  [in]      DWORD                    PreferredMaximum,
  [out]     LPDHCP_CLIENT_INFO_ARRAY *ClientInfo,
  [out]     DWORD                    *ClientsRead,
  [out]     DWORD                    *ClientsTotal
);

Parameters

[in] ServerIpAddress

Unicode string that specifies the IP address or hostname of the DHCP server.

[in] SubnetAddress

DHCP_IP_ADDRESS value that contains the subnet ID. See RFC 950 for more information about subnet ID.

[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 client information structures 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.

[in] PreferredMaximum

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

The minimum value is 1024 bytes (1KB), and the maximum value is 65536 bytes (64KB); if the input value is greater or less than this range, it will be set to the maximum or minimum value, respectively.

[out] ClientInfo

Pointer to a DHCP_CLIENT_INFO_ARRAY structure that contains information on the clients served under this specific subnet. If no clients are available, this field will be null.

[out] ClientsRead

Pointer to a DWORD value that specifies the number of clients returned in ClientInfo.

[out] ClientsTotal

Pointer to a DWORD value that specifies the number of clients for the specified subnet that have not yet been enumerated.

Return value

This function returns ERROR_MORE_DATA upon a successful call. The final call to this method with the last set of subnet clients returns ERROR_SUCCESS. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Remarks

This function requires host byte ordering for all DHCP_IP_ADDRESS values in parameter structures.

Requirements

See also

DHCP_CLIENT_INFO_ARRAY