IBackgroundCopyJob::SetNoProgressTimeout method

Sets the length of time that Delivery Optimization tries to transfer the file after a transient error condition occurs. If there is progress, the timer is reset.

Syntax

HRESULT SetNoProgressTimeout(
  [in] ULONG RetryPeriod
);

Parameters

RetryPeriod [in]

Length of time, in seconds, that Delivery Optimization tries to transfer the file after there has been no progress made. The default retry period for high priority job is 3600 seconds (1 hour) and for low priority job is 86400 seconds (24 hours).

Return value

This method returns the following HRESULT values, as well as others.

Return code Description
S_OK
Retry period successfully set.
DO_E_INVALID_STATE
The state of the job cannot be BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED.

Remarks

If Delivery Optimization does not make progress during the retry period, it moves the state of the job from BG_JOB_STATE_TRANSIENT_ERROR to BG_JOB_STATE_ERROR. If you request error notification, Delivery Optimization then calls your JobError callback.

Requirements

Requirement Value
Minimum supported client
Windows 10, version 1709 [desktop apps only]
Minimum supported server
Windows Server, version 1709 [desktop apps only]
Header
Deliveryoptimization.h
IDL
DeliveryOptimization.idl
Library
Dosvc.lib
DLL
Dosvc.dll
IID
IID_IBackgroundCopyJob is defined as 37668D37-507E-4160-9316-26306D150B12

See also

IBackgroundCopyJob

IBackgroundCopyJob::GetNoProgressTimeout