RegRestoreFile (Compact 2013)

3/26/2014

This function places the OS in a state in which the registry can be replaced by the supplied file on a warm boot.

Syntax

BOOL RegRestoreFile(
  LPCWSTR lpszFile
);

Parameters

• lpszFile
  [in] Specifies the name of the file to be saved. The file can exist on any mounted file system that is accessible fo the OS.

Return Value

TRUE indicates success; FALSE indicates failure. To get extended error information, call GetLastError. GetLastError may fail, returning ERROR_NOT_SUPPORTED.

Remarks

This function is supported only for the object store-based registry*.* To save and restore data in the hive-based registry, see RegSaveKey and RegReplaceKey.

The file to be restored can exist on any mounted file system that is accessible to the OS.

Calling this function copies the file to the RAM file system. This function either renames lpszFile to Restore.fdf or copies the contents to Restore.fdf before it deletes lpszFile. If lpszFile is set to Restore.fdf, this function succeeds, but no data is copied.

To complete a registry replacement operation, the OS must undergo a warm boot. Then, during initialization, the OS reads the Restore.fdf file and creates or stores its contents in the registry.

The data file saved by the OEMWriteRegistry function cannot be imported directly by this function. Use the RegCopyFile funciton to save data to be restored by this function, or use WriteRegistryToOEM to save data to be imported by the OEMReadRegistry function.

Requirements

See Also

Reference

Registry Functions
RegCopyFile

Other Resources

OEMWriteRegistry
OEMReadRegistry