IBackgroundCopyJob::SetMinimumRetryDelay method

Article
11/15/2017

Sets the minimum length of time that DO waits after encountering a transient error condition before trying to transfer the file.

Syntax

HRESULT SetMinimumRetryDelay(
  [in] ULONG RetryDelay
);

Parameters

RetryDelay [in]
Minimum length of time, in seconds, that DO waits after encountering a transient error before trying to transfer the file. The default retry delay is 600 seconds (10 minutes). The minimum retry delay that you can specify is 5 seconds. If you specify a value less than 5 seconds, DO changes the value to 5 seconds. If the value exceeds the no-progress-timeout value retrieved from the GetNoProgressTimeout method, DO will not retry the transfer and moves the job to the BG_JOB_STATE_ERROR state.

Return value

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

Return code	Description
S_OK	Retry delay was successfully set.
BG_E_INVALID_STATE	The state of the job cannot be BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED.

Remarks

To start the job before the minimum retry period expires, call the IBackgroundCopyJob::Resume method.

DO does not retry the job if a network disconnect or disk lock error occurred (for example, chkdsk is running) or the MaxInternetBandwidth Group Policy is zero.

Note Changing the system clock does not affect the minimum retry delay. For example, if the current time is 2:00 P.M. and DO is to retry the job at 2:10 P.M., moving the system clock forward ten or more minutes does not mean DO will retry the job early—DO will still retry the job in ten minutes. To reflect the system clock change in DO, you must restart the computer or the DO service.

Requirements

Minimum supported client	Windows 10, version 1709 [desktop apps only]
Minimum supported server	Windows Server 2016 [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

Partager via