HrRestoreRegister

The HrRestoreRegister function registers a restore operation, interlocking all subsequent restore operations and preventing the restore target from starting until HrRestoreRegisterComplete is called.

Quick Info

HRESULT HrRestoreRegister(
  HBC hbcRestoreContext,        
  LPTSTR szCheckpointFilePath,  
  LPTSTR szLogPath,             
  EDB_RSTMAP rgrstmap[],        
  C crstmap,                    
  LPTSTR szBackupLogPath,       
  ULONG genLow,                 
  ULONG genHigh                 
);
 

Parameters

hbcRestoreContext

Input parameter. The client-side context handle of the restore.

szCheckpointFilePath

Input parameter. The path to the checkpoint file. Typically the same as the system database path. If this parameter is NULL, HrRestoreRegister uses the checkpoint file derived from the backup logs.

szLogPath

Input parameter. The path to the log files on the disk. If the path leads to an empty directory, new log files are generated there. This parameter cannot be NULL.

rgrstmap[]

Input parameter. This is an EDB_RSTMAP structure containing the old and new paths for each database. There should be one row (of two elements) for each database. For the directory there is a row for the system database and a row for the directory database. For the information store, if you are restoring both the private and public databases, there is a row for each of the system, private, and public databases. If you are restoring just the private or just the public databases, there is a row for the system and a row for the (private or public) database. The order of the rows does not matter. The crstmap parameter specifies the number of rows.

crstmap

Input parameter. A LONG specifying the number of rows in rgrstmap.

szBackupLogPath

Input parameter. The path to the directory where the log files are restored. This parameter can be the same as the szLogPath parameter. HrRestoreRegister also puts the patch file is put into this directory. This parameter cannot be NULL.

genLow

Input parameter. The lowest log file number that is restored. This is a hexadecimal number in the range from 0x00000 to 0xFFFFF.

genHigh

Input parameter. The highest log file number that is restored. This is a hex number in the range from 0x00000 to 0xFFFFF.

Return Values

See Return Values.

Remarks

For more information on this function, see Backing Up and Restoring Data.

See Also

HrRestoreRegisterComplete