IBackgroundCopyJob3 Interface Reference

Inheritance diagram for IBackgroundCopyJob3:

Collaboration diagram for IBackgroundCopyJob3:

Public Member Functions
HRESULT	ReplaceRemotePrefix ([in] LPCWSTR OldPrefix, [in] LPCWSTR NewPrefix)
HRESULT	AddFileWithRanges ([in] LPCWSTR RemoteUrl, [in] LPCWSTR LocalName, [in] DWORD RangeCount, [in, size_is(RangeCount)] BG_FILE_RANGE Ranges[])
HRESULT	SetFileACLFlags ([in] DWORD Flags)
HRESULT	GetFileACLFlags ([out, ref] DWORD *Flags)
Public Member Functions inherited from IBackgroundCopyJob2
HRESULT	SetNotifyCmdLine ([unique] LPCWSTR prog, [unique] LPCWSTR params)
HRESULT	GetNotifyCmdLine ([out] LPWSTR *prog, [out] LPWSTR *params)
HRESULT	GetReplyProgress ([in, out] BG_JOB_REPLY_PROGRESS *progress)
HRESULT	GetReplyData ([out, size_is(,(unsigned long) *pLength)] byte **pBuffer, [in, out, unique] UINT64 *pLength)
HRESULT	SetReplyFileName ([unique] LPCWSTR filename)
HRESULT	GetReplyFileName ([out] LPWSTR *pFilename)
HRESULT	SetCredentials (BG_AUTH_CREDENTIALS *cred)
HRESULT	RemoveCredentials (BG_AUTH_TARGET target, BG_AUTH_SCHEME scheme)
Public Member Functions inherited from IBackgroundCopyJob
HRESULT	AddFileSet ([in] ULONG cFileCount, [in, size_is(cFileCount)] BG_FILE_INFO *pFileSet)
HRESULT	AddFile ([in] LPCWSTR RemoteUrl, [in] LPCWSTR LocalName)
HRESULT	EnumFiles ([out] IEnumBackgroundCopyFiles **pEnum)
HRESULT	Suspend ()
HRESULT	Resume ()
HRESULT	Cancel ()
HRESULT	Complete ()
HRESULT	GetId ([out] GUID *pVal)
HRESULT	GetType ([out] BG_JOB_TYPE *pVal)
HRESULT	GetProgress ([out] BG_JOB_PROGRESS *pVal)
HRESULT	GetTimes ([out] BG_JOB_TIMES *pVal)
HRESULT	GetState ([out] BG_JOB_STATE *pVal)
HRESULT	GetError ([out] IBackgroundCopyError **ppError)
HRESULT	GetOwner ([out] LPWSTR *pVal)
HRESULT	SetDisplayName ([in] LPCWSTR Val)
HRESULT	GetDisplayName ([out] LPWSTR *pVal)
HRESULT	SetDescription ([in] LPCWSTR Val)
HRESULT	GetDescription ([out] LPWSTR *pVal)
HRESULT	SetPriority ([in] BG_JOB_PRIORITY Val)
HRESULT	GetPriority ([out] BG_JOB_PRIORITY *pVal)
HRESULT	SetNotifyFlags ([in] ULONG Val)
HRESULT	GetNotifyFlags ([out] ULONG *pVal)
HRESULT	SetNotifyInterface ([in] IUnknown *Val)
HRESULT	GetNotifyInterface ([out] IUnknown **pVal)
HRESULT	SetMinimumRetryDelay ([in] ULONG Seconds)
HRESULT	GetMinimumRetryDelay ([out] ULONG *Seconds)
HRESULT	SetNoProgressTimeout ([in] ULONG Seconds)
HRESULT	GetNoProgressTimeout ([out] ULONG *Seconds)
HRESULT	GetErrorCount ([out] ULONG *Errors)
HRESULT	SetProxySettings ([in] BG_JOB_PROXY_USAGE ProxyUsage, [in, string, unique] const WCHAR *ProxyList, [in, string, unique] const WCHAR *ProxyBypassList)
HRESULT	GetProxySettings ([out] BG_JOB_PROXY_USAGE *pProxyUsage, [out] LPWSTR *pProxyList, [out] LPWSTR *pProxyBypassList)
HRESULT	TakeOwnership ()
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Additional Inherited Members
Public Types inherited from IBackgroundCopyJob2
enum	BG_AUTH_TARGET { BG_AUTH_TARGET_SERVER = 1 , BG_AUTH_TARGET_PROXY }
enum	BG_AUTH_SCHEME {   BG_AUTH_SCHEME_BASIC = 1 , BG_AUTH_SCHEME_DIGEST , BG_AUTH_SCHEME_NTLM , BG_AUTH_SCHEME_NEGOTIATE ,   BG_AUTH_SCHEME_PASSPORT }
typedef struct IBackgroundCopyJob2::_BG_JOB_REPLY_PROGRESS	BG_JOB_REPLY_PROGRESS
typedef BG_BASIC_CREDENTIALS *	PBG_BASIC_CREDENTIALS
union {
BG_BASIC_CREDENTIALS   Basic
}	BG_AUTH_CREDENTIALS_UNION
typedef BG_AUTH_CREDENTIALS *	PBG_AUTH_CREDENTIALS
Public Types inherited from IBackgroundCopyJob
enum	BG_JOB_PRIORITY { BG_JOB_PRIORITY_FOREGROUND = 0 , BG_JOB_PRIORITY_HIGH = 1 , BG_JOB_PRIORITY_NORMAL = 2 , BG_JOB_PRIORITY_LOW = 3 }
enum	BG_JOB_STATE {   BG_JOB_STATE_QUEUED = 0 , BG_JOB_STATE_CONNECTING = 1 , BG_JOB_STATE_TRANSFERRING = 2 , BG_JOB_STATE_SUSPENDED = 3 ,   BG_JOB_STATE_ERROR = 4 , BG_JOB_STATE_TRANSIENT_ERROR = 5 , BG_JOB_STATE_TRANSFERRED = 6 , BG_JOB_STATE_ACKNOWLEDGED = 7 ,   BG_JOB_STATE_CANCELLED = 8 }
enum	BG_JOB_TYPE { BG_JOB_TYPE_DOWNLOAD = 0 , BG_JOB_TYPE_UPLOAD = 1 , BG_JOB_TYPE_UPLOAD_REPLY = 2 }
enum	BG_JOB_PROXY_USAGE { BG_JOB_PROXY_USAGE_PRECONFIG , BG_JOB_PROXY_USAGE_NO_PROXY , BG_JOB_PROXY_USAGE_OVERRIDE , BG_JOB_PROXY_USAGE_AUTODETECT }
typedef struct IBackgroundCopyJob::_BG_FILE_INFO	BG_FILE_INFO
typedef struct IBackgroundCopyJob::_BG_JOB_PROGRESS	BG_JOB_PROGRESS
typedef struct IBackgroundCopyJob::_BG_JOB_TIMES	BG_JOB_TIMES
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN

Detailed Description

Definition at line 45 of file bits2_0.idl.

Member Function Documentation

AddFileWithRanges()

HRESULT IBackgroundCopyJob3::AddFileWithRanges	(	[in] LPCWSTR	RemoteUrl,
		[in] LPCWSTR	LocalName,
		[in] DWORD	RangeCount,
		[in, size_is(RangeCount)] BG_FILE_RANGE	Ranges[]
	)

GetFileACLFlags()

HRESULT IBackgroundCopyJob3::GetFileACLFlags

(

[out, ref] DWORD *

Flags

)

ReplaceRemotePrefix()

HRESULT IBackgroundCopyJob3::ReplaceRemotePrefix	(	[in] LPCWSTR	OldPrefix,
		[in] LPCWSTR	NewPrefix
	)

SetFileACLFlags()

HRESULT IBackgroundCopyJob3::SetFileACLFlags

(

[in] DWORD

Flags

)

---

The documentation for this interface was generated from the following file:

• sdk/include/psdk/bits2_0.idl