IBackgroundCopyJob4::GetPeerCachingFlags method (bits3_0.h)

Article
02/22/2024

Retrieves flags that determine if the files of the job can be cached and served to peers and if BITS can download content for the job from peers.

Syntax

HRESULT GetPeerCachingFlags(
  [out] DWORD *pFlags
);

Parameters

[out] pFlags

Flags that determine if the files of the job can be cached and served to peers and if BITS can download content for the job from peers. The following flags can be set:

Value	Meaning
BG_JOB_ENABLE_PEERCACHING_CLIENT 0x0001	The job can download content from peers.
BG_JOB_ENABLE_PEERCACHING_SERVER 0x0002	The files of the job can be cached and served to peers.

Return value

The method returns the following return values.

Return code	Description
S_OK	Success
E_NOTIMPL	If other flag values are set.

Remarks

BITS can download from peers only if peercaching is enabled both at the computer level and at the job level; this API affects only the job level. For details, see IBackgroundCopyJob4::SetPeerCachingFlags.

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