IBackgroundCopyFile6::GetFilledFileRanges method

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Returns the set of file ranges that have been downloaded.

Syntax

HRESULT GetFilledFileRanges(
  [out]       DWORD         *RangeCount,
  [out] const BG_FILE_RANGE *Ranges[1]
);

Parameters

  • RangeCount [out]
    The number of elements in Ranges.

  • Ranges [out]
    Array of BG_FILE_RANGE structures that describes the ranges that have been downloaded. Ranges will be merged together as much as possible. The ranges are ordered by offset. When done, call the CoTaskMemFree function to free Ranges.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. The error will be E_OUTOFMEMORY if the Ranges array could not be allocated and BG_E_RANDOM_ACCESS_NOT_SUPPORTED if the job is not a download job or if the server loses its ability to support download ranges.

Remarks

GetFilledFileRanges can be requested for any download job that also meets the requirements for BITS_JOB_PROPERTY_ON_DEMAND_MODE jobs.

The requirements for a BITS_JOB_PROPERTY_ON_DEMAND_MODE job is that the transfer must be a DOWNLOAD job. The job must not be DYNAMIC and the server must be an HTTP or HTTPS server and the server requirements for range support must all be met. For more information, see HTTP Requirements for DO Downloads.

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_IBackgroundCopyFile6 is defined as CF6784F7-D677-49FD-9368-CB47AEE9D1AD

See also

IBackgroundCopyFile6