MprConfigServerRestore function (mprapi.h)

The MprConfigServerRestore function restores the router-manager, interface, and phone-book configuration from a backup created by a previous call to MprConfigServerBackup.

Syntax

DWORD MprConfigServerRestore(
  [in] HANDLE hMprConfig,
  [in] LPWSTR lpwsPath
);

Parameters

[in] hMprConfig

Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.

[in] lpwsPath

Pointer to a Unicode string that specifies the path to the directory that contains the backup files. This path should end with a trailing backslash.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value Meaning
ERROR_INVALID_PARAMETER
The hMprConfig parameter is NULL.
ERROR_NOT_ENOUGH_MEMORY
Insufficient resources to complete the operation.
Other
Use FormatMessage to retrieve the system error message that corresponds to the error code returned.
 
 

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header mprapi.h
Library Mprapi.lib
DLL Mprapi.dll

See also

FormatMessage

MprConfigServerBackup

MprConfigServerConnect

Router Configuration Functions

Router Management Reference