IBackgroundCopyJob4::GetMaximumDownloadTime method (bits3_0.h)

Retrieves the maximum time that BITS will spend transferring the files in the job.

Syntax

HRESULT GetMaximumDownloadTime(
  [out] ULONG *pTimeout
);

Parameters

[out] pTimeout

Maximum time, in seconds, that BITS will spend transferring the files in the job.

Return value

The method returns the following return values.

Return code Description
S_OK
Success

Remarks

The value is the maximum elapsed time that the job can spend in the CONNECTING or TRANSFERRING state. Time spent in the QUEUED or TRANSIENT_ERROR state does not count against the timeout value.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header bits3_0.h (include Bits.h)
Library Bits.lib

See also

IBackgroundCopyJob4

IBackgroundCopyJob4::SetMaximumDownloadTime