DhcpGetSuperScopeInfoV4 function (dhcpsapi.h)
The DhcpGetSuperScopeInfoV4 function returns information on the superscope of a DHCP server.
Syntax
DWORD DhcpGetSuperScopeInfoV4(
[in] DHCP_CONST WCHAR *ServerIpAddress,
[out] LPDHCP_SUPER_SCOPE_TABLE *SuperScopeTable
);
Parameters
[in] ServerIpAddress
Unicode string that specifies the IP address or hostname of the DHCP server.
[out] SuperScopeTable
DHCP_SUPER_SCOPE_TABLE structure that contains the returned information for the superscope of the supplied DHCP server.
The memory for this parameter must be free using DhcpRpcFreeMemory.
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 |
|---|---|
|
This call was performed by a client who is not a member of the "DHCP Administrators" security group. |
Remarks
A superscope is the set of all subnets defined on a DHCP server, and hence all scopes along with the IP address ranges each serves. Taken altogether, a superscope provides a complete set of all IP addresses served by the DHCP server. The superscope table provides the IP addresses associated with each subnet. To obtain the IP ranges served by each, DhcpGetSubnetInfo should be called on the IP address provided in each DHCP_SUPER_SCOPE_TABLE_ENTRY structure of the table.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2008 R2 [desktop apps only] |
| Target Platform | Windows |
| Header | dhcpsapi.h |
| Library | Dhcpsapi.lib |
| DLL | Dhcpsapi.dll |