Edit

IBackgroundCopyFile2::GetFileRanges method (bits2_0.h)

  • Article

Retrieves the ranges that you want to download from the remote file.

Syntax

HRESULT GetFileRanges(
  [in, out] DWORD         *RangeCount,
  [out]     BG_FILE_RANGE **Ranges
);

Parameters

[in, out] RangeCount

Number of elements in Ranges.

[out] Ranges

Array of BG_FILE_RANGE structures that specify the ranges to download. When done, call the CoTaskMemFree function to free Ranges.

Return value

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

Return code Description
S_OK
 Success
S_FALSE
 No ranges were specified or the job is an upload or upload-reply job. RangeCount is set to zero and Ranges is set to NULL.

Requirements

Requirement Value
Minimum supported client Windows Vista, Windows XP with SP2,KB842773 on Windows Server 2003, and Windows XP
Minimum supported server Windows Server 2008, Windows Server 2003 with SP1
Target Platform Windows
Header bits2_0.h (include Bits.h)
Library Bits.lib
DLL BitsPrx3.dll

See also

BG_FILE_RANGE

IBackgroundCopyFile2

IBackgroundCopyJob3::AddFileWithRanges