FhServiceStopBackup function

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

Syntax


HRESULT WINAPI FhServiceStopBackup(
  _In_ FH_SERVICE_PIPE_HANDLE Pipe,
  _In_ BOOL                   StopTracking
);

Parameters

Pipe [in]

The communication channel handle returned by an earlier FhServiceOpenPipe call.

StopTracking [in]

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

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

 

 

Show: