DhcpV4FailoverGetSystemTime function (dhcpsapi.h)

The DhcpV4FailoverGetSystemTime function returns the current time on the DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpV4FailoverGetSystemTime(
  [in, optional] LPWSTR  ServerIpAddress,
  [out]          LPDWORD pTime,
                 LPDWORD pMaxAllowedDeltaTime
);

Parameters

[in, optional] ServerIpAddress

Pointer to a null-terminated Unicode string that represents the IP address or hostname of the DHCP server.

[out] pTime

Pointer to a DWORD that returns the current time, in seconds, elapsed since midnight, January 1, 1970, Coordinated Universal Time (UTC), on the DHCP server.

pMaxAllowedDeltaTime

The maximum allowed delta time.

Return value

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, it returns one of the following or an error code from DHCP Server Management API Error Codes.

Value Meaning
ERROR_INVALID_PARAMETER
One or more of the parameters were invalid.

Requirements

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