Edit

IBitsPeerCacheRecord::GetFileRanges method (bits3_0.h)

  • Article

Gets the ranges of the file that are in the cache.

Syntax

HRESULT GetFileRanges(
  [out] DWORD         *pRangeCount,
  [out] BG_FILE_RANGE **ppRanges
);

Parameters

[out] pRangeCount

Number of elements in ppRanges.

[out] ppRanges

Array of BG_FILE_RANGE structures that specify the ranges of the file that are in the cache. When done, call the CoTaskMemFree function to free ppRanges.

Return value

The method returns the following return values.

Return code Description
S_OK
 Success

Remarks

The method always returns at least one range (for the complete file). Multiple ranges can be returned if the application called IBackgroundCopyJob3::AddFileWithRanges to download one or more ranges of a file.

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

BG_FILE_RANGE

IBitsPeerCacheRecord