Edit

Share via

DhcpGetMibInfoV5 function (dhcpsapi.h)

  • Article

The DhcpGetMibInfoV5 function obtains a MIB data structure that contains current statistics about the specified DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpGetMibInfoV5(
  [in, optional] DHCP_CONST WCHAR   *ServerIpAddress,
  [out]          LPDHCP_MIB_INFO_V5 *MibInfo
);

Parameters

[in, optional] ServerIpAddress

Pointer to a zero-delimited string that contains the IPv4 address of the DHCP server for which statistical information is to be retrieved. This value is specified in the format "...".

If this parameter is NULL, then the local DHCP server process is queried.

[out] MibInfo

Pointer to the address of a DHCP_MIB_INFO_V5 structure that contains statistical information about the DHCP server specified in the ServerIpAddress parameter.

Note  

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
ERROR_ACCESS_DENIED
 This call was performed by a client who is not a member of the "DHCP Administrators" security group.
ERROR_DHCP_JET_ERROR
 An error occurred while accessing the DHCP server's database.
ERROR_INVALID_PARAMETER
 One of the parameters provides an invalid value.

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

See also

DHCP_MIB_INFO_V5