FhServiceStartBackup function (fhsvcctl.h)
This function starts an immediate backup for the current user.
Note
FhServiceStartBackup is deprecated and may be altered or unavailable in future releases.
Syntax
HRESULT FhServiceStartBackup(
[in] FH_SERVICE_PIPE_HANDLE Pipe,
[in] BOOL LowPriorityIo
);
Parameters
[in] Pipe
The communication channel handle returned by an earlier FhServiceOpenPipe call.
[in] LowPriorityIo
If TRUE, the File History Service is instructed to use low priority I/O for the immediate backup scheduled by this function. Low-priority I/O reduces impact on foreground user activities. It is recommended to set this parameter to TRUE.
If FALSE, the File History Service is instructed to use normal priority I/O for the immediate backup scheduled by this function. This results in faster backups but negatively affects the responsiveness and performance of user applications.
Return value
S_OK on success, or an unsuccessful HRESULT on failure. Possible unsuccessful HRESULT values include values defined in the FhErrors.h header file.
Remarks
This function does not wait until the immediate backup completes. If an error or warning condition is encountered during backup, it is communicated to the user via an Action Center notification and programmatically retrievable via the IFhConfigMgr::QueryProtectionStatus method.
A backup cycle initiated by calling this function can be stopped using the FhServiceStopBackup function.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 [desktop apps only] |
| Minimum supported server | Windows Server 2012 [desktop apps only] |
| Target Platform | Windows |
| Header | fhsvcctl.h |
| Library | FhSvcCtl.lib |