Edit

Share via

DhcpServerBackupDatabase function (dhcpsapi.h)

  • Article

The DhcpServerBackupDatabase function backs up the DHCP server database configuration, settings, and DHCP client lease record to a specified file location.

Syntax

DWORD DhcpServerBackupDatabase(
  [in] LPWSTR ServerIpAddress,
  [in] LPWSTR Path
);

Parameters

[in] ServerIpAddress

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

[in] Path

Unicode string that specifies the absolute path to the file where the DHCP server database will be backed up.

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.

Requirements

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

See also

DhcpServerRestoreDatabase