Skip to content

Latest commit

 

History

History
214 lines (174 loc) · 6.38 KB

nf-bits-ibackgroundcopyjob-setnotifyflags.md

File metadata and controls

214 lines (174 loc) · 6.38 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:bits.IBackgroundCopyJob.SetNotifyFlags
IBackgroundCopyJob::SetNotifyFlags (bits.h)
Specifies the type of event notification you want to receive, such as job transferred events.
BG_NOTIFY_DISABLE
BG_NOTIFY_FILE_RANGES_TRANSFERRED
BG_NOTIFY_FILE_TRANSFERRED
BG_NOTIFY_JOB_ERROR
BG_NOTIFY_JOB_MODIFICATION
BG_NOTIFY_JOB_TRANSFERRED
IBackgroundCopyJob interface [BITS]
SetNotifyFlags method
IBackgroundCopyJob.SetNotifyFlags
IBackgroundCopyJob::SetNotifyFlags
SetNotifyFlags
SetNotifyFlags method [BITS]
SetNotifyFlags method [BITS]
IBackgroundCopyJob interface
_drz_ibackgroundcopyjob_setnotifyflags
bits.ibackgroundcopyjob_setnotifyflags
bits/IBackgroundCopyJob::SetNotifyFlags
bits\ibackgroundcopyjob_setnotifyflags.htm
Bits
24aa6445-d7bd-4825-9121-402e63ae6f69
12/05/2018
BG_NOTIFY_DISABLE, BG_NOTIFY_FILE_RANGES_TRANSFERRED, BG_NOTIFY_FILE_TRANSFERRED, BG_NOTIFY_JOB_ERROR, BG_NOTIFY_JOB_MODIFICATION, BG_NOTIFY_JOB_TRANSFERRED, IBackgroundCopyJob interface [BITS],SetNotifyFlags method, IBackgroundCopyJob.SetNotifyFlags, IBackgroundCopyJob::SetNotifyFlags, SetNotifyFlags, SetNotifyFlags method [BITS], SetNotifyFlags method [BITS],IBackgroundCopyJob interface, _drz_ibackgroundcopyjob_setnotifyflags, bits.ibackgroundcopyjob_setnotifyflags, bits/IBackgroundCopyJob::SetNotifyFlags
bits.h
Windows
Windows XP
Windows Server 2003
Bits.idl
Bits.lib
QmgrPrxy.dll
Windows
19H1
IBackgroundCopyJob::SetNotifyFlags
bits/IBackgroundCopyJob::SetNotifyFlags
c++
APIRef
kbSyntax
COM
QmgrPrxy.dll
IBackgroundCopyJob.SetNotifyFlags

IBackgroundCopyJob::SetNotifyFlags

-description

Specifies the type of event notification you want to receive, such as job transferred events.

-parameters

-param Val [in]

Set one or more of the following flags to identify the events that you want to receive.

Value Meaning
BG_NOTIFY_JOB_TRANSFERRED
0x0001
All of the files in the job have been transferred.
BG_NOTIFY_JOB_ERROR
0x0002
An error has occurred.
BG_NOTIFY_DISABLE
0x0004
Event notification is disabled. BITS ignores the other flags.
BG_NOTIFY_JOB_MODIFICATION
0x0008
The job has been modified. For example, a property value changed, the state of the job changed, or progress is made transferring the files. This flag is ignored in command-line callbacks if command line notification is specified.
BG_NOTIFY_FILE_TRANSFERRED
0x0010
A file in the job has been transferred. This flag is ignored in command-line callbacks if command line notification is specified.
BG_NOTIFY_FILE_RANGES_TRANSFERRED
0x0020
A range of bytes in the file has been transferred. This flag is ignored in command-line callbacks if command line notification is specified. The flag can be specified for any job, but you will only get notifications for jobs that meet the requirements for a BITS_JOB_PROPERTY_ON_DEMAND_MODE job.

-returns

This method returns the following HRESULT values, as well as others.

Return code Description
S_OK
Type of event notification was successfully set.
E_NOTIMPL
The NotifyFlags value is not valid.
BG_E_INVALID_STATE
The state of the job cannot be BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED.

-remarks

Use the SetNotifyFlags method in conjunction with the IBackgroundCopyJob::SetNotifyInterface and IBackgroundCopyJob2::SetNotifyCmdLine methods to receive event notification.

Examples

See the example code for the IBackgroundCopyJob::SetNotifyInterface method.

-see-also

IBackgroundCopyCallback

IBackgroundCopyCallback2

IBackgroundCopyJob2::SetNotifyCmdLine

IBackgroundCopyJob::GetNotifyFlags

IBackgroundCopyJob::SetNotifyInterface