Edit

Share via

RestoreFile method of the Control class

  • Article

Restore the active configuration of the collector from a backup file.

Syntax

Uint32 RestoreFile(
  [in]  string File,
  [in]  Uint32 OldTimestampLow,
  [in]  Uint32 OldTimestampHigh,
  [out] Uint32 NewTimestampLow,
  [out] Uint32 NewTimestampHigh,
  [out] Uint32 OriginalTimestampLow,
  [out] Uint32 OriginalTimestampHigh,
  [out] string ErrorString,
  [out] string WarningString,
  [out] string InfoString,
  [out] uint32 ErrorType
);

Parameters

File [in]

Name of the backup file to restore, from the list returned by ListBackups().

OldTimestampLow [in]

The timestamp of when the previous configuration was set. If not 0, enables the atomicity check: the new configuration will be applied only if the timestamp of the old configuration matches (i.e. the configuration was not changed in between). This is the low part of FILETIME.

OldTimestampHigh [in]

The timestamp of when the previous configuration was set. If not 0, enables the atomicity check: the new configuration will be applied only if the timestamp of the old configuration matches (i.e. the configuration was not changed in between). This is the high part of FILETIME.

NewTimestampLow [out]

The timestamp of when the new configuration was set, if the call succeeds. This is the low part of FILETIME.

NewTimestampHigh [out]

The timestamp of when the new configuration was set, if the call succeeds. This is the high part of FILETIME.

OriginalTimestampLow [out]

The original timestamp of when the restored configuration was set for the first time. This is the low part of FILETIME.

OriginalTimestampHigh [out]

The original timestamp of when the restored configuration was set for the first time. This is the high part of FILETIME.

ErrorString [out]

The text string with explanation of the error.

WarningString [out]

The text string with warnings.

InfoString [out]

The text string with information about the configuration.

ErrorType [out]

The type of the error: note that 0 or absent indicates success.

0

Success.

1

bad argument format

2

bad argument value

3

resource (socket) open error

4

persistence (file write) error

5

atomicity error (the old timestamp didn't match)

Return value

0

Failure

1

Success

Requirements

Requirement Value
Minimum supported client
 Windows 10 [desktop apps only]
Minimum supported server
 Windows Server 2016
Namespace
 Root\Microsoft\Windows\BootEventCollector
MOF
BootEventCollectorWMI.mof
DLL
BEvtCol.exe

See also

Control