Inheritance diagram for IBackgroundCopyJob:

[legend]

Collaboration diagram for IBackgroundCopyJob:

Classes
struct	_BG_FILE_INFO

struct	_BG_JOB_PROGRESS

struct	_BG_JOB_TIMES

Public Types
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

Public Member Functions
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 ()

Detailed Description

Definition at line 143 of file bits.idl.

Member Typedef Documentation

◆ BG_FILE_INFO

typedef struct IBackgroundCopyJob::_BG_FILE_INFO IBackgroundCopyJob::BG_FILE_INFO

◆ BG_JOB_PROGRESS

typedef struct IBackgroundCopyJob::_BG_JOB_PROGRESS IBackgroundCopyJob::BG_JOB_PROGRESS

◆ BG_JOB_TIMES

typedef struct IBackgroundCopyJob::_BG_JOB_TIMES IBackgroundCopyJob::BG_JOB_TIMES

Member Enumeration Documentation

◆ BG_JOB_PRIORITY

enum IBackgroundCopyJob::BG_JOB_PRIORITY

Enumerator
BG_JOB_PRIORITY_FOREGROUND
BG_JOB_PRIORITY_HIGH
BG_JOB_PRIORITY_NORMAL
BG_JOB_PRIORITY_LOW

Definition at line 163 of file bits.idl.

                 {
        BG_JOB_PRIORITY_FOREGROUND = 0,
        BG_JOB_PRIORITY_HIGH = 1,
        BG_JOB_PRIORITY_NORMAL = 2,
        BG_JOB_PRIORITY_LOW = 3
    } BG_JOB_PRIORITY;

◆ BG_JOB_PROXY_USAGE

enum IBackgroundCopyJob::BG_JOB_PROXY_USAGE

Enumerator
BG_JOB_PROXY_USAGE_PRECONFIG
BG_JOB_PROXY_USAGE_NO_PROXY
BG_JOB_PROXY_USAGE_OVERRIDE
BG_JOB_PROXY_USAGE_AUTODETECT

Definition at line 188 of file bits.idl.

                 {
        BG_JOB_PROXY_USAGE_PRECONFIG,
        BG_JOB_PROXY_USAGE_NO_PROXY,
        BG_JOB_PROXY_USAGE_OVERRIDE,
        BG_JOB_PROXY_USAGE_AUTODETECT
    } BG_JOB_PROXY_USAGE;

◆ BG_JOB_STATE

enum IBackgroundCopyJob::BG_JOB_STATE

Enumerator
BG_JOB_STATE_QUEUED
BG_JOB_STATE_CONNECTING
BG_JOB_STATE_TRANSFERRING
BG_JOB_STATE_SUSPENDED
BG_JOB_STATE_ERROR
BG_JOB_STATE_TRANSIENT_ERROR
BG_JOB_STATE_TRANSFERRED
BG_JOB_STATE_ACKNOWLEDGED
BG_JOB_STATE_CANCELLED

Definition at line 170 of file bits.idl.

                 {
        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
    } BG_JOB_STATE;

◆ BG_JOB_TYPE

enum IBackgroundCopyJob::BG_JOB_TYPE

Enumerator
BG_JOB_TYPE_DOWNLOAD
BG_JOB_TYPE_UPLOAD
BG_JOB_TYPE_UPLOAD_REPLY

Definition at line 182 of file bits.idl.

                 {
       BG_JOB_TYPE_DOWNLOAD = 0,
       BG_JOB_TYPE_UPLOAD = 1,
       BG_JOB_TYPE_UPLOAD_REPLY = 2
    } BG_JOB_TYPE;

Member Function Documentation

◆ AddFile()

HRESULT IBackgroundCopyJob::AddFile	(	[in] LPCWSTR	RemoteUrl,
		[in] LPCWSTR	LocalName
	)

◆ AddFileSet()

HRESULT IBackgroundCopyJob::AddFileSet	(	[in] ULONG	cFileCount,
		[in, size_is(cFileCount)] BG_FILE_INFO *	pFileSet
	)

◆ Cancel()

HRESULT IBackgroundCopyJob::Cancel ( )

◆ Complete()

HRESULT IBackgroundCopyJob::Complete ( )

◆ EnumFiles()

HRESULT IBackgroundCopyJob::EnumFiles ( [out] IEnumBackgroundCopyFiles ** pEnum )

◆ GetDescription()

HRESULT IBackgroundCopyJob::GetDescription ( [out] LPWSTR * pVal )

◆ GetDisplayName()

HRESULT IBackgroundCopyJob::GetDisplayName ( [out] LPWSTR * pVal )

◆ GetError()

HRESULT IBackgroundCopyJob::GetError ( [out] IBackgroundCopyError ** ppError )

◆ GetErrorCount()

HRESULT IBackgroundCopyJob::GetErrorCount ( [out] ULONG * Errors )

◆ GetId()

HRESULT IBackgroundCopyJob::GetId ( [out] GUID * pVal )

◆ GetMinimumRetryDelay()

HRESULT IBackgroundCopyJob::GetMinimumRetryDelay ( [out] ULONG * Seconds )

◆ GetNoProgressTimeout()

HRESULT IBackgroundCopyJob::GetNoProgressTimeout ( [out] ULONG * Seconds )

◆ GetNotifyFlags()

HRESULT IBackgroundCopyJob::GetNotifyFlags ( [out] ULONG * pVal )

◆ GetNotifyInterface()

HRESULT IBackgroundCopyJob::GetNotifyInterface ( [out] IUnknown ** pVal )

◆ GetOwner()

HRESULT IBackgroundCopyJob::GetOwner ( [out] LPWSTR * pVal )

◆ GetPriority()

HRESULT IBackgroundCopyJob::GetPriority ( [out] BG_JOB_PRIORITY * pVal )

◆ GetProgress()

HRESULT IBackgroundCopyJob::GetProgress ( [out] BG_JOB_PROGRESS * pVal )

◆ GetProxySettings()

HRESULT IBackgroundCopyJob::GetProxySettings	(	[out] BG_JOB_PROXY_USAGE *	pProxyUsage,
		[out] LPWSTR *	pProxyList,
		[out] LPWSTR *	pProxyBypassList
	)

◆ GetState()

HRESULT IBackgroundCopyJob::GetState ( [out] BG_JOB_STATE * pVal )

◆ GetTimes()

HRESULT IBackgroundCopyJob::GetTimes ( [out] BG_JOB_TIMES * pVal )

◆ GetType()

HRESULT IBackgroundCopyJob::GetType ( [out] BG_JOB_TYPE * pVal )

◆ Resume()

HRESULT IBackgroundCopyJob::Resume ( )

◆ SetDescription()

HRESULT IBackgroundCopyJob::SetDescription ( [in] LPCWSTR Val )

◆ SetDisplayName()

HRESULT IBackgroundCopyJob::SetDisplayName ( [in] LPCWSTR Val )

◆ SetMinimumRetryDelay()

HRESULT IBackgroundCopyJob::SetMinimumRetryDelay ( [in] ULONG Seconds )

◆ SetNoProgressTimeout()

HRESULT IBackgroundCopyJob::SetNoProgressTimeout ( [in] ULONG Seconds )

◆ SetNotifyFlags()

HRESULT IBackgroundCopyJob::SetNotifyFlags ( [in] ULONG Val )

◆ SetNotifyInterface()

HRESULT IBackgroundCopyJob::SetNotifyInterface ( [in] IUnknown * Val )

◆ SetPriority()

HRESULT IBackgroundCopyJob::SetPriority ( [in] BG_JOB_PRIORITY Val )

◆ SetProxySettings()

HRESULT IBackgroundCopyJob::SetProxySettings	(	[in] BG_JOB_PROXY_USAGE	ProxyUsage,
		[in, string, unique] const WCHAR *	ProxyList,
		[in, string, unique] const WCHAR *	ProxyBypassList
	)

◆ Suspend()

HRESULT IBackgroundCopyJob::Suspend ( )

◆ TakeOwnership()

HRESULT IBackgroundCopyJob::TakeOwnership ( )

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

sdk/include/psdk/bits.idl

Classes

Public Types

Public Member Functions