Edit

Share via

FhServiceStopBackup function (fhsvcctl.h)

  • Article

This function stops an ongoing backup cycle for the current user.

Note

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

Syntax

HRESULT FhServiceStopBackup(
  [in] FH_SERVICE_PIPE_HANDLE Pipe,
  [in] BOOL                   StopTracking
);

Parameters

[in] Pipe

The communication channel handle returned by an earlier FhServiceOpenPipe call.

[in] StopTracking

If TRUE, this function both stops the ongoing backup cycle (if any) and prevents periodic backup cycles for the current user in the future.

If FALSE, this function only stops the ongoing backup cycle.

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.

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

See also

FhServiceOpenPipe