GetPeerCachingFlags Method

IBackgroundCopyJob4::GetPeerCachingFlags method

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

pFlags [out]

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:

ValueMeaning
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 codeDescription
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

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Bits3_0.h (include Bits.h)

IDL

Bits3_0.idl

Library

Bits.lib

See also

Group Policies
IBackgroundCopyJob4
IBackgroundCopyJob4::SetPeerCachingFlags
IBitsPeerCacheAdministration::GetConfigurationFlags
IBitsPeerCacheAdministration::SetConfigurationFlags

 

 

Community Additions

ADD
Show:
© 2016 Microsoft