MprConfigServerRestore

[This is preliminary documentation and subject to change.]

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

DWORD  MprConfigServerRestore(
    HANDLE    hMprConfig,    // handle to the router configuration
    LPWSTR    lpwsPath       // path to backup directory
) 

Parameters

hMprConfig,

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

lpwsPath

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

Return Values

NO_ERROR

The configuration was restored successfully.

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 corresponding to the error code returned.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in mprapi.h.
  Import Library: Link with mprapi.lib.

See Also

FormatMessage, MprConfigServerBackup, MprConfigServerConnect