Export (0) Print
Expand All

FhServiceStartBackup function

This function starts an immediate backup for the current user.

Syntax


HRESULT WINAPI FhServiceStartBackup(
  _In_ FH_SERVICE_PIPE_HANDLE Pipe,
  _In_ BOOL                   LowPriorityIo
);

Parameters

Pipe [in]

The communication channel handle returned by an earlier FhServiceOpenPipe call.

LowPriorityIo [in]

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

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

FhSvcCtl.h

Library

FhSvcCtl.lib

See also

FhServiceOpenPipe
FhServiceStopBackup
IFhConfigMgr::QueryProtectionStatus

 

 

Community Additions

ADD
Show:
© 2015 Microsoft