Expand Minimize

DhcpServerRestoreDatabase function

The DhcpServerRestoreDatabase function restores the settings, configuration, and records for a client lease database from a specific backup location (path).

Syntax


DWORD DhcpServerRestoreDatabase(
  _In_  LPWSTR ServerIpAddress,
  _In_  LPWSTR Path
);

Parameters

ServerIpAddress [in]

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

Path [in]

Unicode string that specifies the full absolute path and filename to the backup file from which the registry configuration file and client lease database will be restored. Note that this operation will overwrite any database currently held in memory.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Return codeDescription
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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008, Windows Server 2008 R2 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpServerBackupDatabase
DhcpScanDatabase

 

 

Community Additions

ADD
Show:
© 2014 Microsoft