FhServiceBlockBackup function (fhsvcctl.h)
This function temporarily blocks backups for the current user.
Note
FhServiceBlockBackup is deprecated and may be altered or unavailable in future releases.
Syntax
HRESULT FhServiceBlockBackup(
[in] FH_SERVICE_PIPE_HANDLE Pipe
);
Parameters
[in] Pipe
The communication channel handle returned by an earlier FhServiceOpenPipe call.
Return value
S_OK on success, or an unsuccessful HRESULT value on failure. Possible unsuccessful HRESULT values include values defined in the FhErrors.h header file.
Remarks
This function instructs the File History Service to not perform backups for the current user until the FhServiceUnblockBackup function is called or the communication channel with the File History Service is closed by calling FhServiceClosePipe.
Call this function prior to performing File History configuration reassociation to ensure that File History configuration and data files are not currently in use. (Otherwise, the IFhReassociation::PerformReassociation method may fail.)
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 |