Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 2.98 KB

nf-fhsvcctl-fhserviceblockbackup.md

File metadata and controls

89 lines (65 loc) · 2.98 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:fhsvcctl.FhServiceBlockBackup
FhServiceBlockBackup function (fhsvcctl.h)
This function temporarily blocks backups for the current user.
FhServiceBlockBackup
FhServiceBlockBackup function [Windows API]
fhsvcctl/FhServiceBlockBackup
winprog.fhserviceblockbackup
winprog\fhserviceblockbackup.htm
winprog
32B5E241-5A5F-4440-9B47-07D5849FA393
12/05/2018
FhServiceBlockBackup, FhServiceBlockBackup function [Windows API], fhsvcctl/FhServiceBlockBackup, winprog.fhserviceblockbackup
fhsvcctl.h
Windows
Windows 8 [desktop apps only]
Windows Server 2012 [desktop apps only]
FhSvcCtl.lib
Windows
19H1
FhServiceBlockBackup
fhsvcctl/FhServiceBlockBackup
c++
APIRef
kbSyntax
LibDef
FhSvcCtl.lib
FhSvcCtl.dll
FhServiceBlockBackup

FhServiceBlockBackup function

-description

This function temporarily blocks backups for the current user.

Note

FhServiceBlockBackup is deprecated and may be altered or unavailable in future releases.

-parameters

-param Pipe [in]

The communication channel handle returned by an earlier FhServiceOpenPipe call.

-returns

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.)

-see-also

FhServiceClosePipe

FhServiceOpenPipe

FhServiceUnblockBackup

IFhReassociation::PerformReassociation